Class ApiKeyProvider

constructor

• new ApiKeyProvider(options): ApiKeyProvider

• Parameters

  • options: {
        apiKey: string;
        tokenLocation?: string;
        tokenName?: string;
        tokenPrefix?: string;
    }

    • apiKey: string

    • Optional tokenLocation?: string

    • Optional tokenName?: string

    • Optional tokenPrefix?: string

  Returns ApiKeyProvider

Readonly apiKey

Readonly tokenLocation

Readonly tokenName

Readonly tokenPrefix

clone

• clone(options?): ApiKeyProvider

• Creates a new credential provider with the same Open ID configuration object.

  Parameters

  • Optional options: Partial<{
        apiKey: string;
        tokenLocation?: string;
        tokenName?: string;
        tokenPrefix?: string;
    }>

    Credentials for the provider.

  Returns ApiKeyProvider

getAccessToken

• getAccessToken(): Promise<AccessToken>

• Returns the API key to the user

  Returns Promise<AccessToken>

resolve

• resolve(): Promise<AccessToken>

• Returns the API key to the user.

  Returns Promise<AccessToken>

Static from

• from(options): ApiKeyProvider

• Parameters

  • options: unknown

  Returns ApiKeyProvider

Static fromEnv

• fromEnv(prefix?): ApiKeyProvider

• Parameters

  • Optional prefix: string

  Returns ApiKeyProvider