Class TokenProvider`Abstract`

Hierarchy (View Summary)

CredentialProvider
- TokenProvider

Index

Constructors

Properties

tokenLocation tokenName tokenPrefix

Methods

clone getAccessToken resolve from fromEnv

Constructors

`Protected`constructor

new TokenProvider(_options?: Record<string, unknown>): TokenProvider
Parameters
- Optional_options: Record<string, unknown>
Returns TokenProvider
Inherited from CredentialProvider.constructor
- Defined in packages/credential-provider/src/CredentialProvider.ts:10

Properties

`Abstract`tokenLocation

tokenLocation: string

The location where the token should be used.

`Abstract`tokenName

tokenName: string

The name of the token location property, usually a header name or querystring key.

`Abstract`tokenPrefix

tokenPrefix: string

The token value may have a prefix, such as 'Basic' or 'Bearer'

Methods

`Abstract`clone

clone(options?: unknown): CredentialProvider
Parameters
- Optionaloptions: unknown
Returns CredentialProvider
Inherited from CredentialProvider.clone
- Defined in packages/credential-provider/src/CredentialProvider.ts:12

`Abstract`getAccessToken

getAccessToken(...args: unknown[]): Promise<AccessToken>
This function should only be implemented when extending this class
Parameters
- ...args: unknown[]
Returns Promise<AccessToken>
- Defined in packages/credential-provider/src/TokenProvider.ts:25

`Abstract`resolve

resolve(): Promise<AccessToken>
This function should only be implemented when extending this class

Returns Promise<AccessToken>
- Defined in packages/credential-provider/src/TokenProvider.ts:30

`Static`from

from(_data?: unknown): CredentialProvider
Parameters
- Optional_data: unknown
Returns CredentialProvider
Inherited from CredentialProvider.from
- Defined in packages/credential-provider/src/CredentialProvider.ts:2

`Static`fromEnv

fromEnv(_prefix?: string): CredentialProvider
Parameters
- Optional_prefix: string
Returns CredentialProvider
Inherited from CredentialProvider.fromEnv
- Defined in packages/credential-provider/src/CredentialProvider.ts:6