Class AuthHandler

Auth handler that integrates with ConnectionManager.

Index

Constructors

constructor

Methods

prepareAuth handleChallenge getAuthMethod refreshToken

Constructors

constructor

new AuthHandler(provider: CredentialsProvider, config?: AuthConfig): AuthHandler
Parameters
- provider: CredentialsProvider
- config: AuthConfig = {}
Returns AuthHandler
- Defined in src/auth/provider.ts:165

Methods

prepareAuth

prepareAuth(): Promise<
    | {
        method: AuthMethod;
        data: | {
            token?: string;
            bootstrapToken?: string;
            deviceToken?: string;
            password?: string;
        }
        | undefined;
    }
    | null,
>
Prepare auth data for connect request.

Returns Promise<
    | {
        method: AuthMethod;
        data: | {
            token?: string;
            bootstrapToken?: string;
            deviceToken?: string;
            password?: string;
        }
        | undefined;
    }
    | null,
>
- Defined in src/auth/provider.ts:173

handleChallenge

handleChallenge(
challenge: { nonce: string; timestamp: number; expiresAt: number },
): Promise<{ signature: string; timestamp: number }>
Handle incoming challenge from server.
Parameters
- challenge: { nonce: string; timestamp: number; expiresAt: number }
Returns Promise<{ signature: string; timestamp: number }>
- Defined in src/auth/provider.ts:195

getAuthMethod

getAuthMethod(): AuthMethod | null
Get the current auth method being used.

Returns AuthMethod | null
- Defined in src/auth/provider.ts:238

refreshToken

refreshToken(): Promise<RefreshResult | null>
Refresh token if supported (for reconnection).

Returns Promise<RefreshResult | null>
- Defined in src/auth/provider.ts:245

Class AuthHandler

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AuthHandler

Methods

prepareAuth

Returns Promise<
    | {
        method: AuthMethod;
        data: | {
            token?: string;
            bootstrapToken?: string;
            deviceToken?: string;
            password?: string;
        }
        | undefined;
    }
    | null,
>

handleChallenge

Parameters

Returns Promise<{ signature: string; timestamp: number }>

getAuthMethod

Returns AuthMethod | null

refreshToken

Returns Promise<RefreshResult | null>

Settings

On This Page

Class AuthHandler

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AuthHandler

Methods

prepareAuth

Returns Promise< | { method: AuthMethod; data: | { token?: string; bootstrapToken?: string; deviceToken?: string; password?: string; } | undefined; } | null,>

handleChallenge

Parameters

Returns Promise<{ signature: string; timestamp: number }>

getAuthMethod

Returns AuthMethod | null

refreshToken

Returns Promise<RefreshResult | null>

Settings

On This Page

Returns Promise<
| {
method: AuthMethod;
data: | {
token?: string;
bootstrapToken?: string;
deviceToken?: string;
password?: string;
}
| undefined;
}
| null,
>