yatki

read-env

Convert environment variables into JSON object

  "description": "Convert environment variables into JSON object",

    "url": "git+ssh://git@github.com:yatki/read-env.git"

    "url": "https://github.com/yatki/read-env/issues"

  "homepage": "https://github.com/yatki/read-env",

    "prepublish": "npm run build && npm test",

    "eslint:fix": "eslint . --fix --color",

    "test:coverage": "npm run compile && npm test",

    "coveralls": "nyc npm run test:coverage && nyc report --reporter=text-lcov | coveralls"

      "command": "babel --presets env -d dist/ src/",

> Convert environment variables into JSON object with parsed values.

[![NPM version](https://badge.fury.io/js/read-env.svg)](https://www.npmjs.com/package/read-env)

[![Build Status](https://travis-ci.org/yatki/read-env.svg?branch=master)](https://travis-ci.org/yatki/read-env)

[![Coverage Status](https://coveralls.io/repos/github/yatki/read-env/badge.svg?branch=master&)](https://coveralls.io/github/yatki/read-env?branch=master)

Let's say you have some environment variables starting with prefix "**EXAMPLE_**" like below:

EXAMPLE_ARRAY_KEY= '[1,2,3, "string", {"prop": "value"}, 5.2]',

  arrayKey: [ 1, 2, 3, 'string', { prop: 'value' }, 5.2 ],

### `readEnv(prefix = null, transformKey = 'camelcase')`

You can pass a string prefix as first paremeter like below:

const optionsLower = readEnv('EXAMPLE', 'lowercase');

    return string.charAt(0).toUpperCase() + string.slice(1).toLowerCase();

const optionsUcfirst = readEnv('EXAMPLE', ucfirst);

    array: false, //not gonna parse arrays

  }, //still gonna parse object, int, float and boolean

- `prefix` (type: *string*, default: *null*): filters environment variables by prefix

- `includePrefix` (type: *bool*, default: *false*): set true if you want to keep prefix in property names.

- `transformKey` (type: *null*|*string*|*function*, default: *'camelcase'*): transform environment variable name.

  1. `null`, doesn't transform the environment variable name.

  1. `camelcase`, transforms variable name to camelCase.

  1. `lowercase`, transforms variable name to lowercase.

  1. `uppercase`, transforms variable name to UPPERCASE.

  1. `fn(varName)`, you can write your own transformer function (*varName* will be provided with prefix, if *includePrefix* is *true*)

- `parse` (type: *bool*|*object*, default: *object*):

  1. `false`: returns raw environment variable value

  1. `{}`: allows you to define which value types are going to be parsed.

      - `object` (type: *bool*, default: *true*): parse string as object (value must be valid JSON input, see: [JSON.parse](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_JSON.parse())).

      - `array` (type: *bool*, default: *true*): parse stringified array (value must be valid JSON input, see: [JSON.parse](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_JSON.parse())).

      - `int` (type: *bool*, default: *true*): parse digits into integer (value consists of only numbers).

      - `float` (type: *bool*, default: *true*): parse decimals into integer (value consists of only numbers with decimal point).

  typeInterval:  process.env.X_NIGHTMARE_TYPE_INTERVAL || 50,

I wrote this, and nightmare is fully configurable with environment variables :)

const nightmareConfig = readEnv('X_NIGHTMARE');

const nightmare = Nightmare(nightmareConfig);

		{
		"name": "read-env",
		"version": "1.1.0",
		"version": "1.1.1",
		"description": "Convert environment variables into JSON object",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

		@@ -119,3 +119,3 @@ # read-env
		typeInterval: process.env.X_NIGHTMARE_TYPE_INTERVAL \|\| 50,
		//... other properties goes forever
		//... other properties go forever
		});
		@@ -132,7 +132,5 @@ ```
		```

		## Contribution

		## LICENCE

		MIT (c) 2017 Mehmet Yatkı
		MIT (c) 2017 Mehmet Yatkı

Worsened metrics