Interface TokenProvider

Provider interface for retrieving authorization credentials.

Implement this interface to supply tokens to the withAuthorization middleware. The provider is called before each request and on retry after 401 responses, allowing for token refresh or rotation.

Example

// Static token provider
const staticProvider: TokenProvider = {
  getToken: async () => ({
    accessToken: "my-api-key",
    tokenType: "Bearer"
  })
};

Example

// Refreshing token provider (e.g., for OAuth)
class OAuthTokenProvider implements TokenProvider {
  private accessToken: string;
  private refreshToken: string;

  async getToken(): Promise<AuthorizationToken> {
    if (this.isExpired()) {
      await this.refresh();
    }
    return { accessToken: this.accessToken, tokenType: "Bearer" };
  }
}

interface TokenProvider {
getToken(): Promise<AuthorizationToken>;
}

Index

Methods

getToken

Methods

getToken

getToken(): Promise<AuthorizationToken>
Retrieves the current authorization credentials.

Called before each request and before each retry attempt on 401 responses. Implementations may return cached tokens or fetch fresh ones as needed.

Returns Promise<AuthorizationToken>
A promise resolving to the authorization token credentials.

Throws
If token retrieval fails, the error propagates to the caller.
- Defined in packages/middleware-authorization/src/with-authorization.ts:84

Interface TokenProvider

Example

Example

Index

Methods

Methods

getToken

Returns Promise<AuthorizationToken>

Throws

Settings

On This Page