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

    @ominestre/config-reader

    1.0.0 • Public • Published

    Config Reader

    Build Status

    Node module for reading JSON or YAML config and returning a Plain Ol' JavaScript Object.

    Contributing

    Reference CONTRIBUTING.md for instructions on how to contribute to this project.

    Usage

    configReader.getConfig( String )

    const configReader = require('@ominestre/config-reader');
    const config = configReader.getConfig('/path/to/my/config.json');

    The string should preferrably be an absolute path to your configuration file. This module will attempt to resolve a relative path to your current working directory but that should be considered volatile.

    It will throw an exception if you point to a file that isn't of extension .json, .yml, or .yaml. It will also throw an exception if your path can't be resolved or if the file can't be read.

    Keywords

    none

    Install

    npm i @ominestre/config-reader

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    14.3 kB

    Total Files

    17

    Last publish

    Collaborators

    • avatar