Class ApiKeyProvider

constructor

• new ApiKeyProvider(
      options: {
          apiKey: string;
          tokenLocation?: string;
          tokenName?: string;
          tokenPrefix?: string;
      },
  ): ApiKeyProvider

  Parameters

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

  Returns ApiKeyProvider

ReadonlyapiKey

ReadonlytokenLocation

ReadonlytokenName

ReadonlytokenPrefix

clone

• clone(
      options?: Partial<
          {
              apiKey: string;
              tokenLocation?: string;
              tokenName?: string;
              tokenPrefix?: string;
          },
      >,
  ): ApiKeyProvider

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

  Parameters

  • Optionaloptions: 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>

Staticfrom

• from(options: unknown): ApiKeyProvider

  Parameters

  • options: unknown

  Returns ApiKeyProvider

StaticfromEnv

• fromEnv(prefix?: string): ApiKeyProvider

  Parameters

  • Optionalprefix: string

  Returns ApiKeyProvider