\n\nA functional getter/parser for `process.env`.\n\n## Features\n\n- Casts number-like values to numbers.\n- Casts `\"true\"` and `\"false\"` to booleans.\n- Parses JSON.\n- Throws if `process` or `process.env` are non-objects.\n- (Optional) Throw if a variable is undefined.\n\n## Install\n\n```bash\n$ npm i @darkobits/env\n```\n\n## Use\n\nThis package's default export is a function with the following signature:\n\n```ts\ninterface Env {\n (variableName: string, strict: boolean = false): any;\n has(variableName: string): boolean;\n eq(variableName: string, value: any, strict: boolean = false): boolean;\n}\n```\n\nKeeping in mind that the values in `process.env` [may only be strings](https://nodejs.org/api/process.html#process_process_env), let's assume `process.env` looks like this:\n\n```json\n{\n \"FOO\": \"foo\",\n \"BAR\": \"42\",\n \"BAZ\": \"true\",\n \"QUX\": \"false\",\n \"JSON\": \"{\\\"kittens\\\": true}\"\n}\n```\n\n```ts\nimport env from '@darkobits/env';\n\nenv('FOO') //=> 'foo'\ntypeof env('FOO') //=> 'string'\n\nenv('BAR') //=> 42\ntypeof env('BAR') //=> 'number'\n\nenv('BAZ') //=> true\ntypeof env('BAZ') //=> 'boolean'\n\nenv('QUX') //=> false\ntypeof env('BAZ') //=> 'boolean'\n\nenv('JSON') //=> {kittens: true}\ntypeof env('JSON') //=> 'object'\n\nenv('NOAP') //=> undefined\nenv('NOAP', true) //=> throws\n\n// Throws if process.env has been tampered-with.\nprocess.env = null;\nenv('FOO') //=> throws\n\n// Throws if process has been tampered-with, or if process doesn't exist.\nprocess = null;\nenv('FOO') //=> throws\n```\n\n### `env.has`\n\nThis helper predicate is a shorthand for `Object.keys(process.env).includes(x)`. It returns `true` if the provided variable name exists in `process.env` and `false` otherwise. Useful when you don't care what the value of a variable is, only whether it is set or not.\n\nUsing our example `process.env` object from above:\n\n```ts\nenv.has('FOO') //=> true\nenv.has('UNICORNS') //=> false\n```\n\n### `env.eq`\n\nThis helper predicate is a shorthand for `env(variableName) === value`. It returns `true` if the provided variable name exists in `process.env` and is equal to the provided value and `false` otherwise. Useful when you need to quickly test the value of an environment variable. A third `strict` argument may be set to `true` to cause `env.eq` to throw if the provided variable does not exist in `process.env`.\n\n**Note:** When comparing against non-primitives (objects, arrays), env.eq will serialize the provided `value` and compare it against the serialized (re: string) form of the environment variable.\n\nUsing our example `process.env` object from above:\n\n```ts\nimport env from '@darkobits/env';\n\nenv.eq('FOO', 'foo') //=> true\nenv.eq('BAR', 42) //=> true\nenv.eq('BAR', null) //=> false\nenv.eq('BAZ', true) //=> true\nenv.eq('JSON', {kittens: true}) //=> true\n```\n\n \n\n \n\n","readmeFilename":"README.md"}
![](\"https://user-images.githubusercontent.com/441546/102322726-5e6d4200-3f34-11eb-89f2-c31624ab7488.png\")
\n