Module "auth"

Index

Enumerations

Interfaces

Type aliases

CredentialsProvider

Functions

Type aliases

CredentialsProvider

CredentialsProvider: () => Promise<ClientCredentials>

A Credentials provider is a function which promises client credentials

Type declaration

- (): Promise<ClientCredentials>
- Returns Promise<ClientCredentials>

Functions

Authentication

Authentication(baseUrl: string, provider: CredentialsProvider): (Anonymous function)

- Defined in auth.ts:25
Parameters
- baseUrl: string
- provider: CredentialsProvider
Returns (Anonymous function)

ConstantCredentials

ConstantCredentials(credentials: ClientCredentials): CredentialsProvider

- Defined in auth.ts:88
ConstantCredentials creates a new CredentialsProvider which always returns the credentials used to create it.
example
```
import * as TigerBay from 'tigerbay';
const provider = TigerBay.Auth.ConstantCredentials(
 {
     clientId: 'myClientId',
     clientSecret: 'myClientSecret'
 }
);
```
Parameters
- credentials: ClientCredentials
  
  Static credentials to return
Returns CredentialsProvider

EnvCredentials

EnvCredentials(prefix?: string): CredentialsProvider

- Defined in auth.ts:101
EnvCredentials creates a CredentialsProvider which fetches credentials from the process environment

Parameters
- Default value prefix: string = "TB"
  
  Environment prefix (default: TB)
Returns CredentialsProvider

Generated using TypeDoc