Socket
Socket
Sign inDemoInstall

env-reader

Package Overview
Dependencies
1
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

env-reader

Streaming environment variable reader


Version published
Maintainers
1
Install size
20.5 kB
Created

Readme

Source

Build Status

NPM

Media Suite

env-reader

Streaming environment variable reader

Accepts simple key=value data and passes it on after performing some basic filtering out of things like blank lines, comment lines and invalid env lines. Now also handles removing the 'export' keyword from the start of env var lines

Examples

Require the module

var env = require('env-reader')()

Listening for data events

env.on('data', function (envLine) {
  //do something
})

Writing data

env.write('\n#comment line\ninvalid line\nvalid=line\n    \n')

//only valid=line would be passed emitted, the rest would be disguarded

This module was built with the following type of input in mind:

#ENV config file

#environment definition
ENV=development

#database definition
DB_HOST=localhost
DB_USER=user
DB_PASS=password
DB_NAME=development

export EXPORTED_VAR=true

and will emit the following lines from such a file one after another:

ENV=development
DB_HOST=localhost
DB_USER=user
DB_PASS=password
DB_NAME=development
EXPORTED_VAR=true

if streamed the data in the following way:

fs.createReadStream('example.file').pipe(env)

If you were to send it all the data at once like:

var envFileString = "#ENV config file\n#environment definition\nENV=development\n\n" +
  "#database definition\nDB_HOST=localhost\nDB_USER=user\nDB_PASS=password\n" +
  "DB_NAME=development"

env.write(envFileString)

it would still break the string apart and emit the cleaned up env pieces 1 after another

Keywords

FAQs

Last updated on 19 Jun 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc