Skip to main content

OAuth.ITokenRefresher

A helper to automatically refresh tokens

Methods

Methods

dispose

dispose(): void

Shut down, stop refreshing, and clean up resources

on

on: method3 overloads
on(event: 'refresh', callback: () => void): ISubscription

Listen for successful refreshes of the token

ParameterType
event'refresh'
The 'refresh' event type
callback() => void
The callback to call on a refresh

Returns: ISubscription

on(event: 'error', callback: (e: Error) => void): ISubscription

Listen for errors when refreshing the token

ParameterType
event'error'
The 'error' event type
callback(e: Error) => void
The callback to call on error

Returns: ISubscription

on(refreshObserver: OAuth.IRefreshObserver): ISubscription

Attach an observer that can listen for refresh or error events

ParameterType
refreshObserverOAuth.IRefreshObserver
an observer for refresh and error events

Returns: ISubscription