meshblu-config

    9.0.2 • Public • Published

    meshblu-config

    Meshblu Config from environment or JSON file

    Install

    npm install meshblu-config

    Usage

    var MeshbluConfig = require('meshblu-config');
    var meshbluConfig = new MeshbluConfig();
    var config = meshbluConfig.generate({});
     
    var Meshblu = require('meshblu');
    var meshblu = Meshblu.createConnection(config);

    Options (showing default values)

    Functions

    Constructor

    Parameter Type Required Description
    options object no can contain any of these keys: envVars, defaultFilename, env

    var meshbluConfig = new MeshbluConfig({envVars: {uuid: "MESHBLU_UUID", resolveSrv: "MESHBLU_RESOLVE_SRV"}})
    var meshbluConfig = new MeshbluConfig({defaultFilename: './something-like-meshblu.json'})
    var meshbluConfig = new MeshbluConfig({env: {"MESHBLU_UUID": "the-uuid"}})

    generate

    Parse the default file, environment, and data and return the combined configuration

    Parameter Type Required Description
    data object no Data to process

    var data = meshbluConfig.generate()

    Advanced Functions

    get

    Returns the current config

    Parameter Type Required Description

    var data = meshbluConfig.get();

    fromFile

    Loads any values from the JSON file into the config

    Parameter Type Required Description
    filename string no JSON file to parse, defaults to ``./meshblu.json`

    meshbluConfig.fromFile('./filename.json')
    var data = meshbluConfig.get();

    fromEnv

    Loads any values from the env

    Parameter Type Required Description
    env object no Environment to use, defaults to process.env

    meshbluConfig.fromEnv({"MESHBLU_UUID": "the-uuid"})
    var data = meshbluConfig.get();

    fromData

    Loads any values from the env

    Parameter Type Required Description
    data object yes Data to use

    meshbluConfig.fromData({uuid: "the-uuid"})
    var data = meshbluConfig.get();

    Keywords

    Install

    npm i meshblu-config

    DownloadsWeekly Downloads

    17

    Version

    9.0.2

    License

    MIT

    Last publish

    Collaborators

    • sqrtofsaturn
    • royvandewater
    • peterdemartini
    • chrismatthieu
    • iamruinous
    • octoblu-user