environment
Module provides API to access, set and unset environment variables via exported
env
object.
1 | var { env } = require( 'api-utils/environment' ); |
You can get the value of an environment variable, by accessing property that has name of desired variable:
1 | var PATH = env.PATH; |
You can check existence of an environment variable by checking if property with such variable name exists:
1 2 | console.log( 'PATH' in env); // true console.log( 'FOO' in env); // false |
You can set value of an environment variable by setting a property:
1 2 | env.FOO = 'foo' ; env.PATH += ':/my/path/' |
You can unset environment variable by deleting a property:
1 | delete env.FOO; |
Limitations
There is no way to enumerate existing environment variables, also env
won't have any enumerable properties:
1 | console.log(Object.keys(env)); // [] |
Environment variable will be unset, show up as non-existing if it's set
to null
, undefined
or ''
.
1 2 3 4 | env.FOO = null ; console.log( 'FOO' in env); // false env.BAR = '' ; console.log(env.BAR); // undefined |