Package @google-cloud/rcloadenv (3.0.1)

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
Name
Description
variables
env
NodeJS.ProcessEnv
opts
{}
Returns
Type
Description
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
Name
Description
configName
string
env
NodeJS.ProcessEnv
Returns
Type
Description
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
Name
Description
configName
string
Returns
Type
Description
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
Name
Description
variables
oldEnv
NodeJS.ProcessEnv
Returns
Type
Description
NodeJS.ProcessEnv
Create a Mobile Website
View Site in Mobile | Classic
Share by: