@orioro/parse-env v1.0.1

env

npm install @orioro/env
yarn add @orioro/env

API Docs

• parseEnvValue(optionName, optional)
• parseFsRead(optionName, optional, encoding)
• parseList(optionName, optional, separator)
• parseBoolean(optionName, optional)
• parseNumber(optionName, optional)
• parseJson(optionName, optional)
• parseEnv(map, env)

parseEnvValue(optionName, optional)

• optionName {String}
• optional {Boolean}
• Returns: {String | null}

parseFsRead(optionName, optional, encoding)

• optionName {String}
• optional {Boolean}
• encoding {BufferEncoding}
• Returns: {Buffer | String | null}

parseList(optionName, optional, separator)

• optionName {String}
• optional {Boolean}
• separator {String | RegExp}
• Returns: {String[] | null}

parseBoolean(optionName, optional)

• optionName {String}
• optional {Boolean}
• Returns: {Boolean | null}

parseNumber(optionName, optional)

• optionName {String}
• optional {Boolean}
• Returns: {Number | null}

parseJson(optionName, optional)

• optionName {String}
• optional {Boolean}
• Returns: {Array | PlainObject | null}

parseEnv(map, env)

• map {PlainObject}
• env {EnvOptions}
• Returns: {PlainObject}