obj2env

Create files storing environment variables by using objects.

Use dotenv for loading an .env file in your application.

:cloud: Installation

# Using npm
npm install --save obj2env

# Using yarn
yarn add obj2env

:clipboard: Example

var { item, toArray, toFile } = require("obj2env")

console.log(item("PORT", 8080))
// => PORT=8080

console.log(toArray({
    PORT: 8080
  , NODE_ENV: "production"
}))
// => [ 'PORT=8080', 'NODE_ENV=production' ]

// Will create a file named `.env` in this directory
toFile({
    PORT: 8080
  , NODE_ENV: "production"
}, __dirname, err => {
    err && console.error(err)
    // The .env file contains:
    // PORT=8080
    // NODE_ENV=production
})

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

:memo: Documentation

envToItem(name, value)

Converts the pair of name and value into a string.

Params

• String name: The environment variable name.
• String value: The environment variable value.

Return

• String The stringified pair.

envToArray(obj)

Converts an object of environment variables into an array.

Params

• Object obj: The object containing environment variables to stringify.

Return

• Array An array of stringified pairs.

toFile(obj, dir, cb)

Create a file named .env in the specified directory.

Params

• Object obj: The object containing environment variables to stringify.
• String dir: The directory where to create the .env file (default: the current directory).
• Function cb: The callback function.

Return

• Stream The writable stream.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• obj2env-cli

:scroll: License

MIT © Bloggify