gev

get-env-var

Get environment variable

Showing:

Popularity

Downloads/wk

25

GitHub Stars

0

Maintenance

Last Commit

4yrs ago

Contributors

3

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

get-env-var

A little function that reads an environment variable from process.env with support for default values and a optional mapping function applied to the data read from the environment.

It will throw an exception if key can't be found and no default value is supplied.

build status modules status

npm badge

Example

var getEnvVar = require('get-env-var');

getEnvVar('SOME_VAL', 'defaultValue');
getEnvVar('SOME_INT_VAL', Number.parseInt);
getEnvVar('SOME_INT_VAL', 20, Number.parseInt);

Shorthands

The following shorthand methods currently exists. They have the same API as the generic method. The mapping function is applied to the transformed value.

Boolean

getEnvVar.boolean is a shorthand method that returns true if the value equals 'true' and false in all other cases.

Integer

getEnvVar.integer is a shorthand method that calls parseInt(value, 10).

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial