@bzr/bazaar
    Preparing search index...

    Type Alias BazaarOptions

    Options for initializing a BazaarApp instance

    type BazaarOptions = {
        appId: string;
        bazaarUri?: string;
        loginRedirectUri: string;
        onApiConnect?: (bzr: BazaarApp) => Promise<void>;
        onApiConnectError?: (bzr: BazaarApp, message: string) => Promise<void>;
        onLogin?: (bzr: BazaarApp) => Promise<void>;
        onLoginError?: (bzr: BazaarApp, message: string) => Promise<void>;
    }
    Index

    Properties

    appId bazaarUri? loginRedirectUri onApiConnect? onApiConnectError? onLogin? onLoginError?

    Properties

    appId: string
    bazaarUri?: string

    Public URI for the API & OAuth server.

    loginRedirectUri: string

    The URI the auth server redirects to with an auth code after login request approval.

    onApiConnect?: (bzr: BazaarApp) => Promise<void>

    Provide a callback to handle API connections. Will be called after login and any subsequent re-connection.

    onApiConnectError?: (bzr: BazaarApp, message: string) => Promise<void>

    Provide a callback to handle failed data API connections. E.g. unauthorized, or expired token.

    onLogin?: (bzr: BazaarApp) => Promise<void>

    Provide a callback to handle a successful login.

    e.g. Set state, redirect, etc.

    onLoginError?: (bzr: BazaarApp, message: string) => Promise<void>

    Provide a callback to handle a failed login. E.g. invalid authorization code.

    e.g. Set state, redirect, etc.

    Settings

    Member Visibility

    On This Page

    Properties