Variable default

Type declaration

• LoginContainer: typeof default

• LoginFlowError: typeof LoginFlowError

• LoginFlowErrorType: typeof LoginFlowErrorType

• LoginWindowPopup: typeof LoginWindowPopup

• awaitLoginContainer: ((container: default) => Promise<void>)

  • • (container: default): Promise<void>

    • Wraps login container in a promise.

      Returns

      Promise

      Throws

      LoginFlowError LoginFlowError

      Parameters

      • container: default

        container

      Returns Promise<void>

• isLoggedIn: ((documentCookie?: string) => boolean)

  • • (documentCookie?: string): boolean

    • Check if the user appears to be logged in from the client side. Do NOT use for authentication as the result may be tempered with.

      Returns

      true if the user appears to be logged in.

      Parameters

      • Optional documentCookie: string

        Optional cookie string (for testing).

      Returns boolean

• setup: ((params: Pick<Options, "appId"> & Partial<Options>) => void)

  • • (params: Pick<Options, "appId"> & Partial<Options>): void

    • Allows setting appId and realm.

      Returns

      void

      Parameters

      • params: Pick<Options, "appId"> & Partial<Options>

        appId and realm

      Returns void

• startLogin: ((loginOptions?: LoginOptions, buildLoginWindow?: ((url: URL) => LoginWindow)) => Promise<void>)

  • • (loginOptions?: LoginOptions, buildLoginWindow?: ((url: URL) => LoginWindow)): Promise<void>

    • Starts the login process and creates a promise around it. Returns a promise that resolves as soon as the popup closes.

      Returns

      Promise

      Throws

      LoginFlowError LoginFlowError

      Parameters

      • loginOptions: LoginOptions = {}

        containing the userClass

      • Optional buildLoginWindow: ((url: URL) => LoginWindow)

        optional container to render the login flow in

        • • (url: URL): LoginWindow

          • Parameters

            • url: URL

            Returns LoginWindow

      Returns Promise<void>

• startLoginContainer: ((loginOptions?: LoginOptions, buildLoginWindow?: ((url: URL) => LoginWindow)) => default)

  • • (loginOptions?: LoginOptions, buildLoginWindow?: ((url: URL) => LoginWindow)): default

    • Starts the login process. Returns a promise that resolves as soon as the popup closes.

      Returns

      Promise

      Throws

      error LoginFlowError

      Parameters

      • loginOptions: LoginOptions = {}

        containing the userClass

      • Optional buildLoginWindow: ((url: URL) => LoginWindow)

        optional container to render the login flow in

        • • (url: URL): LoginWindow

          • Parameters

            • url: URL

            Returns LoginWindow

      Returns default