README
environment
helpers for interacting with the process environment
install
$ npm install @robireton/environment
usage
const env = require('@robireton/environment')
env.parseBool('SOME_NAME')
env.parseInt('SOME_NAME')
env.parseInt('SOME_NAME', 1970)
env.parseFloat('SOME_NAME')
env.parseFloat('SOME_NAME', 2.71828)
env.parseList('SOME_NAME')
methods
parseBool( string )
arguments
string: name of an environment variable
returns
bool: whether or not the environment variable is set to the string true (case insensitive)
example
environment.parseBool('SHELL')
// => false
parseInt( name : string [, default : int ] )
arguments
name : string: name of an environment variable
default : int: a value to return if the name is not set or can’t be parsed
returns
int: result of parsing the value of name
examples
environment.parseInt('CLICOLOR')
// => 1
environment.parseInt('SHELL', 1066)
// => 1066
parseInts( name : string [, pattern : RegExp or string ] )
arguments
name : string: name of an environment variable
pattern : regular expression or string (defaults to /[^0-9-]+/ — one or more non-digit/hyphen-minus characters) used to split the value of the environment variable into an array
returns
[ int, … ]: an array of integers, or an empty array if name isn’t set
example
environment.parseInts('127.0.0.1', '.')
// => [ 127, 0, 0, 1 ]
parseFloat( name : string [, default : float ] )
arguments
name : string: name of an environment variable
default : float: a value to return if the name is not set or can’t be parsed
returns
float: result of parsing the value of name
examples
environment.parseFloat('TERM_PROGRAM_VERSION')
// => 433
environment.parseFloat('SHELL', 3.1415)
// => 3.1415
parseList( name : string [, pattern : RegExp or string ] )
arguments
name : string: name of an environment variable
pattern : regular expression or string (defaults to /\W+/ — one or more non-word characters) used to split the value of the environment variable into an array
returns
[ string, … ]: an array of (non-empty) strings, or an empty array if name isn’t set
example
environment.parseList('PATH', ':')
// => [ '/usr/local/bin', '/usr/bin', '/bin', '/usr/sbin', '/sbin' ]