Package @google-cloud/rcloadenv (3.0.1)

Stay organized with collections Save and categorize content based on your preferences.

Interfaces

RCLoadEnvOptions

TransformOptions

Variable

Functions

apply(variables, env, opts)

export declare function apply(variables: Variable[], env?: NodeJS.ProcessEnv, opts?: {}): NodeJS.ProcessEnv;

Applies the provided raw variables to the given object.

Parameters
NameDescription
variablesVariable[]
envNodeJS.ProcessEnv
opts{}
Returns
TypeDescription
NodeJS.ProcessEnv

getAndApply(configName, env, opts)

export declare function getAndApply(configName: string, env?: NodeJS.ProcessEnv, opts?: RCLoadEnvOptions): Promise

Retrieves all variables in the given config and mixes them into the given object.

Parameters
NameDescription
configNamestring
envNodeJS.ProcessEnv
optsRCLoadEnvOptions
Returns
TypeDescription
Promise<__global.NodeJS.ProcessEnv>

{Promise}

getVariables(configName, opts)

export declare function getVariables(configName: string, opts?: RCLoadEnvOptions): Promise

Retrieves all variables in the given config.

Parameters
NameDescription
configNamestring
optsRCLoadEnvOptions
Returns
TypeDescription
Promise<Variable[]>

{Promise}

transform(variables, oldEnv, opts)

export declare function transform(variables: Variable[], oldEnv?: NodeJS.ProcessEnv, opts?: TransformOptions): NodeJS.ProcessEnv;

Transforms the given array of raw variables into a simple key-value object.

In: [{name:"...",value:"..."}, ...] Out: { VAR1: "...", VAR2: "...", ... }

Parameters
NameDescription
variablesVariable[]
oldEnvNodeJS.ProcessEnv
optsTransformOptions
Returns
TypeDescription
NodeJS.ProcessEnv