Class RefreshingAuthProvider

An authentication provider implementation that uses user refresh tokens to automatically refresh the access token whenever necessary.

Hierarchy

EventEmitter
- RefreshingAuthProvider

Implements

AuthProvider

Index

Constructors

constructor

new RefreshingAuthProvider(config): RefreshingAuthProvider
Creates a new authentication provider that can automatically refresh tokens.
Parameters
- config: RefreshingAuthProviderConfig
  
  The configuration object.
Returns RefreshingAuthProvider
Overrides EventEmitter.constructor
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:69

Properties

`Readonly` onRefresh

onRefresh: ((handler) => Listener) = ...

Type declaration

- (handler): Listener
- Fires when a user's token is successfully refreshed.
  Parameters
  - handler: EventHandler<[userId: number, token: AccessToken]>
  Returns Listener

Accessors

clientId

get clientId(): string
The client ID.

Returns string
Implementation of AuthProvider.clientId
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:74

Methods

addListener

addListener<Args>(event, callback): Listener
Type Parameters
- Args extends any[]
Parameters
- event: EventBinder<Args>
- callback: EventHandler<Args>
Returns Listener
Inherited from EventEmitter.addListener
- Defined in node_modules/typed-event-emitter/index.d.ts:36

addUser

addUser(user, token): void
Adds a user to the auth provider registry.
Parameters
- user: UserIdResolvable
  
  The ID of the user.
- token: AccessToken
  
  The initial token data.
Returns void
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:93

addUserForCode

addUserForCode(code, scopes?): Promise<AccessTokenWithUserId>
Exchanges an authorization code for an access token and adds the user to the provider.
Parameters
- code: string
  
  The authorization code.
- Optional scopes: string[]
  
  The authorization code.
Returns Promise<AccessTokenWithUserId>
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:163

addUserForToken

addUserForToken(token): Promise<AccessTokenWithUserId>
Finds out the user associated to the given access token and adds them to the provider.

If you already know the ID of the user you are adding, consider using addUser instead.
Parameters
- token: AccessToken
  
  The initial token data.
Returns Promise<AccessTokenWithUserId>
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:108

getAccessTokenForUser

getAccessTokenForUser(user, scopes?): Promise<AccessTokenWithUserId>
Gets the access token data for the given user.
Parameters
- user: UserIdResolvable
  
  The ID of the user to get the access token of.
- Optional scopes: string[]
  
  The list of required scopes that will be compared against the existing token scopes.
Returns Promise<AccessTokenWithUserId>

Throws
UnregisteredUserError if user is not registered in the provider.

Throws
MissingScopeError if user is not registered in the provider.
Implementation of AuthProvider.getAccessTokenForUser
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:213

getScopesForUser

getScopesForUser(user): string[]
Gets the scopes for a user that are currently available using the access token.

If scopes were not set on user registration then it returns an empty array.
Parameters
- user: UserIdResolvable
Returns string[]

Throws
UnregisteredUserError if user is not registered in the provider.
Implementation of AuthProvider.getScopesForUser
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:201

hasUser

hasUser(user): boolean
Checks whether a user was added to the provider.
Parameters
- user: UserIdResolvable
  
  The user to check.
Returns boolean
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:83

on

on<Args>(event, callback): Listener
Alias for addListener.
Type Parameters
- Args extends any[]
Parameters
- event: EventBinder<Args>
- callback: EventHandler<Args>
Returns Listener
Inherited from EventEmitter.on
- Defined in node_modules/typed-event-emitter/index.d.ts:40

refreshAccessTokenForUser

refreshAccessTokenForUser(user): Promise<AccessTokenWithUserId>
Refreshes the access token.

This method is optional to implement.
Parameters
- user: UserIdResolvable
  
  The ID of the user to refresh the access token of.
Returns Promise<AccessTokenWithUserId>
Implementation of AuthProvider.refreshAccessTokenForUser
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:247

registerEvent

registerEvent<T>(): ((handler) => Listener)
Type Parameters
- T extends any[]
Returns ((handler) => Listener)
- - (handler): Listener
  - Parameters
    - handler: EventHandler<T>
    Returns Listener
    
    Typeparam
    T The event handler signature.
Typeparam
T The event handler signature.
Inherited from EventEmitter.registerEvent
- Defined in node_modules/typed-event-emitter/index.d.ts:65

removeListener

removeListener(): void
Remove all listeners.

Returns void
Inherited from EventEmitter.removeListener
- Defined in node_modules/typed-event-emitter/index.d.ts:44
removeListener(listener): void
Remove specific listener.
Parameters
- listener: Listener
  
  Listener to remove.
Returns void
Inherited from EventEmitter.removeListener
- Defined in node_modules/typed-event-emitter/index.d.ts:50
removeListener(event, callback?): void
Remove callback function from given event.
Parameters
- event: Function
  
  Event where function might have been added to
- Optional callback: Function
  
  Callback function to remove from event
Returns void
Inherited from EventEmitter.removeListener
- Defined in node_modules/typed-event-emitter/index.d.ts:57

removeUser

removeUser(user): void
Removes a user from the auth provider registry.
Parameters
- user: UserIdResolvable
  
  The ID of the suer to add.
Returns void
- Defined in packages/auth/src/providers/RefreshingAuthProvider.ts:197

Class RefreshingAuthProvider

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: RefreshingAuthProviderConfig

Returns RefreshingAuthProvider

Properties

Readonly onRefresh

Type declaration

Parameters

handler: EventHandler<[userId: number, token: AccessToken]>

Returns Listener

Accessors

clientId

Returns string

Methods

addListener

Type Parameters

Args extends any[]

Parameters

event: EventBinder<Args>

callback: EventHandler<Args>

Returns Listener

addUser

Parameters

user: UserIdResolvable

token: AccessToken

Returns void

addUserForCode

Parameters

code: string

Optional scopes: string[]

Returns Promise<AccessTokenWithUserId>

addUserForToken

Parameters

token: AccessToken

Returns Promise<AccessTokenWithUserId>

getAccessTokenForUser

Parameters

user: UserIdResolvable

Optional scopes: string[]

Returns Promise<AccessTokenWithUserId>

Throws

Throws

getScopesForUser

Parameters

user: UserIdResolvable

Returns string[]

Throws

hasUser

Parameters

user: UserIdResolvable

Returns boolean

on

Type Parameters

Args extends any[]

Parameters

event: EventBinder<Args>

callback: EventHandler<Args>

Returns Listener

refreshAccessTokenForUser

Parameters

user: UserIdResolvable

Returns Promise<AccessTokenWithUserId>

registerEvent

Type Parameters

T extends any[]

Returns ((handler) => Listener)

Parameters

handler: EventHandler<T>

Returns Listener

Typeparam

Typeparam

`Readonly` onRefresh

`Optional` scopes: string[]

`Optional` scopes: string[]

`Optional` callback: Function