default | dotenv-azure

Hierarchy

default

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new default(__namedParameters?: DotenvAzureOptions): default

- Defined in src/dotenv-azure.ts:34
Initializes a new instance of the DotenvAzure class.

Parameters
- __namedParameters: DotenvAzureOptions = {}
Returns default

Properties

Private Optional Readonly clientId

clientId: string

Private Optional Readonly clientSecret

clientSecret: string

Private Optional Readonly connectionString

connectionString: string

Private Readonly keyVaultClients

keyVaultClients: {}

Type declaration

[vaultURL: string]: SecretClient

Private Readonly keyVaultRateLimitMinTime

keyVaultRateLimitMinTime: number

Private Optional Readonly tenantId

tenantId: string

Methods

config

config(options?: DotenvAzureConfigOptions): Promise<DotenvAzureConfigOutput>

- Defined in src/dotenv-azure.ts:60
Loads Azure App Configuration and Key Vault variables and .env file contents into process.env. Example: 'KEY=value' becomes { parsed: { KEY: 'value' } }

Parameters
- options: DotenvAzureConfigOptions = {}
  
  controls behavior
Returns Promise<DotenvAzureConfigOutput>

Protected getAppConfigurations

getAppConfigurations(client: AppConfigurationClient): Promise<AppConfigurations>

- Defined in src/dotenv-azure.ts:117
Parameters
- client: AppConfigurationClient
Returns Promise<AppConfigurations>

Private getAzureCredentials

getAzureCredentials(dotenvVars?: DotenvParseOutput): AzureCredentials

- Defined in src/dotenv-azure.ts:197
Parameters
- dotenvVars: DotenvParseOutput = {}
Returns AzureCredentials

Protected getKeyVaultClient

getKeyVaultClient(credentials: AzureCredentials, vaultURL: string): SecretClient

- Defined in src/dotenv-azure.ts:155
Parameters
- credentials: AzureCredentials
- vaultURL: string
Returns SecretClient

Protected getKeyVaultReferenceInfo

getKeyVaultReferenceInfo(__namedParameters: ConfigurationSetting): KeyVaultReferenceInfo

- Defined in src/dotenv-azure.ts:172
Parameters
- __namedParameters: ConfigurationSetting
Returns KeyVaultReferenceInfo

Protected getSecretsFromKeyVault

getSecretsFromKeyVault(credentials: AzureCredentials, vars: KeyVaultReferences): Promise<VariablesObject>

- Defined in src/dotenv-azure.ts:132
Parameters
- credentials: AzureCredentials
- vars: KeyVaultReferences
Returns Promise<VariablesObject>

Protected isKeyVaultReference

isKeyVaultReference(config: ConfigurationSetting): boolean

- Defined in src/dotenv-azure.ts:191
Parameters
- config: ConfigurationSetting
Returns boolean

loadFromAzure

loadFromAzure(dotenvVars?: DotenvParseOutput): Promise<VariablesObject>

- Defined in src/dotenv-azure.ts:99
Loads your Azure App Configuration and Key Vault variables. It does not change process.env.

Parameters
- Optional dotenvVars: DotenvParseOutput
  
  dotenv parse() output containing azure credentials variables
Returns Promise<VariablesObject>

an object with keys and values

parse

parse(src: string, options?: DotenvParseOptions): Promise<VariablesObject>

- Defined in src/dotenv-azure.ts:87
Parses a string or buffer in the .env file format into an object and merges it with your Azure App Configuration and Key Vault variables. It does not change process.env.

Parameters
- src: string
  
  contents to be parsed
- Optional options: DotenvParseOptions
  
  additional options
Returns Promise<VariablesObject>

an object with keys and values

Protected validateFromEnvExample

validateFromEnvExample(options: DotenvAzureConfigOptions, dotenvError?: Error): void

- Defined in src/dotenv-azure.ts:107
Parameters
- options: DotenvAzureConfigOptions
- Optional dotenvError: Error
Returns void

Generated using TypeDoc