AuthInterceptorOptions

Hierarchy

• AuthInterceptorOptions

Index

Properties

• canAuthorize

• onAuthorizationFailure

• reauthorize

• setAuthorizationData

Properties

canAuthorize

• canAuthorize: function

Defined in packages/auth-interceptor/src/authInterceptor.types.ts:30

Determine if request should be processed, by checking request's options (i.e. check for a domain match)

param Request options

Type declaration:

▸ (options: NormalizedHttpOptions): boolean

Parameters:

Name	Type
options	NormalizedHttpOptions

onAuthorizationFailure

• onAuthorizationFailure: function

Defined in packages/auth-interceptor/src/authInterceptor.types.ts:24

This function is called when:

• authorize() function throws an error,

• a second call to an api endpoint results in 401.

Type declaration:

▸ (err: AuthError): Promisable

Parameters:

Name	Type
err	AuthError

reauthorize

• reauthorize: function

Defined in packages/auth-interceptor/src/authInterceptor.types.ts:10

Obtain authorization data. At this point previous token has expired or Unauthorized response status code has been received. You can call refresh token endpoint.

Type declaration:

▸ (): Promisable

setAuthorizationData

• setAuthorizationData: function

Defined in packages/auth-interceptor/src/authInterceptor.types.ts:17

Insert authorization data to the request.

param Authorization data obtained earlier by {#authorize}

param Request options

Type declaration:

▸ (options: NormalizedHttpOptions): Promisable

Parameters:

Name	Type
options	NormalizedHttpOptions