/node-openfin-config-builder

OpenFin-Config-Builder is a Node.js module that automates creating and updating OpenFin application config files

Primary LanguageJavaScriptMIT LicenseMIT

openfin-config-builder

Build Status

OpenFin-Config-Builder is a Node.js module that automates creating and updating OpenFin application config files. You can read up on application config options on the OpenFin config file API docs.

Install

$ npm install --save openfin-config-builder

Usage

var configBuilder = require('openfin-config-builder');

//you can create new config files
//configBuilder.create(configOptionsObject, configPath);
configBuilder.create({
        startup_app: {
            name: 'myAppName',
            url: 'http://www.openfin.co'
        }
    }, 'app.json').then(function (){
        console.log('Success');
    }).fail(function (err){
        console.log(err);
    });

//you can also update existing configs with updated values
//configBuilder.update(configOptionsObject, configPath);
configBuilder.update({
        startup_app: {
            name: 'staging_app',
            url: 'http://staging-app.com'
        }
    }, 'app.json').then(function (){
        console.log('Success');
    }).fail(function (err){
        console.log(err);
    });

Application Config Info:

You can read up on OpenFin application config options on the OpenFin config file API docs.

License

MIT

The code in this repository is covered by the included license.

However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin’s Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or just email us at support@openfin.co with questions.

https://openfin.co/developer-agreement/
https://openfin.co/licensing/