https://github.com/luqmanoop/parse-dotenv

Zero dependency .env to javascript object parser
https://github.com/luqmanoop/parse-dotenv

env env-object nodejs parse-env parser

Last synced: about 1 month ago
JSON representation

Zero dependency .env to javascript object parser

• Host: GitHub
• URL: https://github.com/luqmanoop/parse-dotenv
• Owner: luqmanoop
• License: mit
• Created: 2019-04-05T23:17:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T19:17:00.000Z (over 1 year ago)
• Last Synced: 2024-08-06T01:57:00.747Z (about 2 months ago)
• Topics: env, env-object, nodejs, parse-env, parser
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/parse-dotenv
• Size: 1.9 MB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - luqmanoop/parse-dotenv - Zero dependency .env to javascript object parser (TypeScript)

README

        
# parse-dotenv

> Zero-dependency .env to javascript object parser

![Travis (.org)](https://img.shields.io/travis/codeshifu/parse-dotenv.svg)

[![Coverage Status](https://coveralls.io/repos/github/codeshifu/parse-dotenv/badge.svg?branch=master)](https://coveralls.io/github/codeshifu/parse-dotenv?branch=master)

## Installation

```bash

npm install parse-dotenv --save

```

## Usage

```bash

# .env

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

```

```javascript

import parseEnv from "parse-dotenv";

const parsed = parseEnv();

console.log(parsed.DB_CONNECTION); // mysql

```

or provide a path (relative to project root) to env

```javascript

const parseEnv = require("parse-dotenv");

const parsed = parseEnv(".env.example");

console.log(parsed.DB_PORT); // 3306

```

## API

### path

Type: `string`

Default: `path.resolve(process.cwd(), '.env')`

### opts

Type: `Object`

#### opts.emptyLines

Type: `boolean`

Default: false

Parse empty lines in env file

```javascript

{

  emptyLines: true; // parse empty lines in env

}

```

#### opts.comments

Type: `boolean`

Default: false

Parse empty lines in env file

```javascript

{

  comments: true; // parse comments in env

}

```

## Related

- [sync-dotenv](https://github.com/codeshifu/sync-dotenv) - Keep your .env in

  sync with .env.example

## LICENSE

This project is licensed under [MIT](https://github.com/codeshifu/parse-env/blob/master/LICENSE)