Neurosis Prevention Mechanism
    Wondering what’s next for npm?Check out our public roadmap! »

    envfile
    TypeScript icon, indicating that this package has built-in type declarations

    6.14.0 • Public • Published

    envfile

    Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Parse and stringify the environment configuration files and format, also known as .env files and dotenv files

    What are environment configuration files?

    They are files use to configure environments by applications and servers that support them. Generally they look like this:

    a=1
    b:2
    c = 3
    d : 4
    

    They are commonly also called envfiles, .env files, and dotenv files.

    Usage

    Complete API Documentation.

    Via the Command Line

    Requires a global installation of envfile: npm install -g envfile

    # envfile to JSON 
    echo -e "a=1\nb:2" | envfile env2json > config.json
     
    # JSON to envfile 
    echo '{"a":1,"b":2}' | envfile json2env > config.env

    Via Node.js

    // Include envfile
    const { parse, stringify } = require('envfile')
     
    // Parse an envfile string
    console.log(parse('a=1\nb:2'))
     
    // Stringify a javascript object to an envfile string
    console.log(stringify({ a: 1, b: 2 }))

    Install

    npm

    Install Globally

    • Install: npm install --global envfile
    • Executable: envfile

    Install Locally

    • Install: npm install --save envfile
    • Executable: npx envfile
    • Import: import * as pkg from ('envfile')
    • Require: const pkg = require('envfile')

    Deno

    import * as pkg from 'https://unpkg.com/envfile@^6.14.0/edition-deno/index.ts'

    Skypack

    <script type="module">
        import * as pkg from '//cdn.skypack.dev/envfile@^6.14.0'
    </script> 

    unpkg

    <script type="module">
        import * as pkg from '//unpkg.com/envfile@^6.14.0'
    </script> 

    jspm

    <script type="module">
        import * as pkg from '//dev.jspm.io/envfile@6.14.0'
    </script> 

    Editions

    This package is published with the following editions:

    • envfile/source/index.ts is TypeScript source code with Import for modules
    • envfile/edition-browsers/index.js is TypeScript compiled against ES2019 for web browsers with Import for modules
    • envfile aliases envfile/edition-esnext/index.js
    • envfile/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 13 || 14 with Require for modules
    • envfile/edition-esnext-esm/index.js is TypeScript compiled against ESNext for Node.js 12 || 13 || 14 with Import for modules
    • envfile/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

    History

    Discover the release history by heading on over to the HISTORY.md file.

    Contribute

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    Backers

    Maintainers

    These amazing people are maintaining this project:

    Sponsors

    No sponsors yet! Will you be the first?

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i envfile

    DownloadsWeekly Downloads

    137,813

    Version

    6.14.0

    License

    MIT

    Unpacked Size

    36 kB

    Total Files

    23

    Last publish

    Collaborators

    • avatar
    • avatar