diff options
Diffstat (limited to 'tools/addon-sdk-1.4/packages/api-utils/docs/environment.md')
-rw-r--r-- | tools/addon-sdk-1.4/packages/api-utils/docs/environment.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/tools/addon-sdk-1.4/packages/api-utils/docs/environment.md b/tools/addon-sdk-1.4/packages/api-utils/docs/environment.md new file mode 100644 index 0000000..5697a4f --- /dev/null +++ b/tools/addon-sdk-1.4/packages/api-utils/docs/environment.md @@ -0,0 +1,39 @@ +Module provides API to access, set and unset environment variables via exported +`env` object. + + var { env } = require('api-utils/environment'); + +You can get the value of an environment variable, by accessing property that +has name of desired variable: + + var PATH = env.PATH; + +You can check existence of an environment variable by checking if property with +such variable name exists: + + console.log('PATH' in env); // true + console.log('FOO' in env); // false + +You can set value of an environment variable by setting a property: + + env.FOO = 'foo'; + env.PATH += ':/my/path/' + +You can unset environment variable by deleting a property: + + delete env.FOO; + +## Limitations ## + +There is no way to enumerate existing environment variables, also `env` +won't have any enumerable properties: + + console.log(Object.keys(env)); // [] + +Environment variable will be unset, show up as non-existing if it's set +to `null`, `undefined` or `''`. + + env.FOO = null; + console.log('FOO' in env); // false + env.BAR = ''; + console.log(env.BAR); // undefined |