Package @google-cloud/rcloadenv (4.0.0)

Interfaces

RCLoadEnvOptions

TransformOptions

Variable

Functions

apply(variables, env, opts)

exportdeclarefunctionapply(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)

exportdeclarefunctiongetAndApply(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<"\"process\"".__global.NodeJS.ProcessEnv>

{Promise}

getVariables(configName, opts)

exportdeclarefunctiongetVariables(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)

exportdeclarefunctiontransform(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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.