Class DefaultTokenStore

Implements

AuthTokenStore

Index

Constructors

Properties

keyValueStorage?

Methods

clearDeviceMetadata clearTokens getDeviceMetadata getKeyValueStorage getLastAuthUser getOAuthMetadata loadTokens setAuthConfig setKeyValueStorage setOAuthMetadata setupNotify storeTokens teardownNotify

Constructors

constructor

new DefaultTokenStore(): DefaultTokenStore
Returns DefaultTokenStore

Properties

`Optional`keyValueStorage

keyValueStorage?: KeyValueStorageInterface

Methods

clearDeviceMetadata

clearDeviceMetadata(username?: string): Promise<void>
Parameters
- Optionalusername: string
Returns Promise<void>
Implementation of AuthTokenStore.clearDeviceMetadata

clearTokens

clearTokens(): Promise<void>
Returns Promise<void>
Implementation of AuthTokenStore.clearTokens

getDeviceMetadata

getDeviceMetadata(username?: string): Promise<DeviceMetadata | null>
Parameters
- Optionalusername: string
Returns Promise<DeviceMetadata | null>
Implementation of AuthTokenStore.getDeviceMetadata

getKeyValueStorage

getKeyValueStorage(): KeyValueStorageInterface
Returns KeyValueStorageInterface

getLastAuthUser

getLastAuthUser(): Promise<string>
Returns Promise<string>
Implementation of AuthTokenStore.getLastAuthUser

getOAuthMetadata

getOAuthMetadata(): Promise<OAuthMetadata | null>
Returns Promise<OAuthMetadata | null>
Implementation of AuthTokenStore.getOAuthMetadata

loadTokens

loadTokens(): Promise<CognitoAuthTokens | null>
Returns Promise<CognitoAuthTokens | null>
Implementation of AuthTokenStore.loadTokens

setAuthConfig

setAuthConfig(authConfig: AuthConfig): void
Parameters
- authConfig: AuthConfig
Returns void

setKeyValueStorage

setKeyValueStorage(keyValueStorage: KeyValueStorageInterface): void
Parameters
- keyValueStorage: KeyValueStorageInterface
Returns void
Implementation of AuthTokenStore.setKeyValueStorage

setOAuthMetadata

setOAuthMetadata(metadata: OAuthMetadata): Promise<void>
Parameters
- metadata: OAuthMetadata
Returns Promise<void>
Implementation of AuthTokenStore.setOAuthMetadata

setupNotify

setupNotify(): void
Returns void

storeTokens

storeTokens(tokens: CognitoAuthTokens): Promise<void>
Parameters
- tokens: CognitoAuthTokens
Returns Promise<void>
Implementation of AuthTokenStore.storeTokens

teardownNotify

teardownNotify(): void
Detaches the cross-tab storage listener registered by setupNotify and clears the retained unsubscribe handle, allowing a subsequent setupNotify() to re-register (e.g. after a storage swap, in tests, or during HMR). No-op when notify was never set up.

Returns void