Class AuthPlus (5.0.5)

Inheritance

GoogleAuth > AuthPlus

Package

googleapis-common

Properties

AwsClient

AwsClient: typeof AwsClient;
Property Value
Type Description
typeof AwsClient

Compute

Compute: typeof Compute;
Property Value
Type Description
typeof Compute

ExternalAccountClient

ExternalAccountClient: typeof ExternalAccountClient;
Property Value
Type Description
typeof ExternalAccountClient

GoogleAuth

GoogleAuth: typeof GoogleAuth;
Property Value
Type Description
typeof GoogleAuth

IdentityPoolClient

IdentityPoolClient: typeof IdentityPoolClient;
Property Value
Type Description
typeof IdentityPoolClient

JWT

JWT: typeof JWT;
Property Value
Type Description
typeof JWT

OAuth2

OAuth2: typeof OAuth2Client;
Property Value
Type Description
typeof OAuth2Client

Methods

getClient(options)

getClient(options?: GoogleAuthOptions): Promise<Compute | JWT | UserRefreshClient | BaseExternalAccountClient | Impersonated>;

Override getClient(), memoizing an instance of auth for subsequent calls to getProjectId().

Parameter
Name Description
options GoogleAuthOptions
Returns
Type Description
Promise<Compute | JWT | UserRefreshClient | BaseExternalAccountClient | Impersonated>

getProjectId()

getProjectId(): Promise<string>;

Override getProjectId(), using the most recently configured auth instance when fetching projectId.

Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: ProjectIdCallback): void;
Parameter
Name Description
callback ProjectIdCallback
Returns
Type Description
void