modules

@authgear/web / Exports

@authgear/web

Table of contents

Classes

• AuthgearError
• CancelError
• OAuthError
• ServerError
• TransientTokenStorage
• WebContainer

Interfaces

• AuthorizeOptions
• AuthorizeResult
• ConfigureOptions
• ContainerOptions
• ReauthenticateOptions
• ReauthenticateResult
• SettingOptions
• TokenStorage
• UserInfo
• WebContainerDelegate

Type aliases

• ErrorName
• PromptOption
• SessionState
• SessionStateChangeReason

Variables

• ErrorNames
• VERSION
• default

Type aliases

ErrorName

Ƭ ErrorName: typeof ErrorNames[keyof typeof ErrorNames]

ErrorName is the union of the keys of ErrorNames.

Defined in

packages/authgear-web/index.d.ts:55

---

PromptOption

Ƭ PromptOption: "none" | "login" | "consent" | "select_account"

Prompt parameter options.

Defined in

packages/authgear-web/index.d.ts:98

---

SessionState

Ƭ SessionState: "UNKNOWN" | "NO_SESSION" | "AUTHENTICATED"

The session state.

An freshly constructed instance has the session state "UNKNOWN";

After a call to configure, the session state would become "AUTHENTICATED" if a previous session was found, or "NO_SESSION" if such session was not found.

Defined in

packages/authgear-web/index.d.ts:160

---

SessionStateChangeReason

Ƭ SessionStateChangeReason: "NO_TOKEN" | "FOUND_TOKEN" | "AUTHENTICATED" | "LOGOUT" | "INVALID" | "CLEAR"

The reason why SessionState is changed.

These reasons can be thought of as the transition of a SessionState, which is described as follows:

                                                         LOGOUT / INVALID                                          +----------------------------------------------+                                          v                                              |   State: UNKNOWN ----- NO_TOKEN ----> State: NO_SESSION ---- AUTHENTICATED -----> State: AUTHENTICATED     |                                                                                ^     +--------------------------------------------------------------------------------+                                        FOUND_TOKEN

Defined in

packages/authgear-web/index.d.ts:178

Variables

ErrorNames

• Const ErrorNames: Object

ErrorNames contains all possible name in ServerError

Type declaration

Name	Type
AlreadyExists	"AlreadyExists"
BadRequest	"BadRequest"
Forbidden	"Forbidden"
InternalError	"InternalError"
Invalid	"Invalid"
NotFound	"NotFound"
ServiceUnavailable	"ServiceUnavailable"
TooManyRequest	"TooManyRequest"
Unauthorized	"Unauthorized"

Defined in

packages/authgear-web/index.d.ts:62

---

VERSION

• Const VERSION: string

Defined in

packages/authgear-web/index.d.ts:226

---

default

• Const default: WebContainer

Default container.

remarks This is a global shared container, provided for convenience.

Defined in

packages/authgear-web/index.d.ts:311