Bandiera Client (Node.js)

This is a client for talking to the Bandiera feature flagging service from a Node.js application. This client currently only implements the read methods of the v2 Bandiera API.

Installation

npm install bandiera-client

or add bandiera-client to your package.json file.

Usage

Create an instance of the bandiera client:

var bandiera = require('bandiera-client');
var client = bandiera.createClient('http://your-bandiera-server.com');

Each method of the client requires a callback. These callbacks accept two arguments, the first is an error object or null the second contains the response.

In the examples below, params is an object containing query parameters to send as part of the request to Bandiera. This argument is optional in all of the client methods. See the API documentation for available parameters.

Get features for all groups:

client.getAll(params, function (error, groups) {
    /*
    groups == {
        group_name: {
            feature_name: Boolean,
            ...
        },
        ...
    }
    */
});

// or

client.getAll(function (error, groups) {
    // ...
});

Get features for a group:

client.getFeaturesForGroup('group_name', params, function (error, features) {
    /*
    features == {
        feature_name: Boolean,
        ...
    }
    */
});

// or

client.getFeaturesForGroup('group_name', function (error, features) {
    // ...
});

Get an individual feature:

client.getFeature('group_name', 'feature_name', params, function (error, feature) {
    /*
    feature = Boolean
    */
});

// or

client.getFeature('group_name', 'feature_name', function (error, feature) {
    // ...
});

Options

The Node.js Bandiera client also accepts options in construction which allow you to tweak the client's behaviour:

var client = bandiera.createClient('http://your-bandiera-server.com', {
    // options go here
});

logger.debug (function)

A logging function which will be called with debug messages. This should accept the same arguments as console.log. Defaults to an empty function.

logger.warn (function)

A logging function which will be called with warning messages. This should accept the same arguments as console.log. Defaults to an empty function.

timeout (number)

A timeout (in milliseconds) after which an API request should fail. Defaults to 400.

Contributing

If you would like to contribute please make sure that the tests pass and that the code lints successfully.

make lint test

License

Copyright © 2018 Springer Nature. Node Bandiera client is licensed under the MIT License.

History

3.0.0 (2017-08-01)

• Drops support for node < 4 & 5
• Update request to 2.87.0 (a security update, requiring node >= 4)
• Adds Travis testing for node 8
• Adds .editorconfig
• Update year in copyright notice

2.4.7 (2017-03-01)

• Update request to 2.79.0 or greater
• Update date in copyright notice
• Remove coveralls leftovers

2.4.6 (2016-09-26)

• Require request 2.74 or greater. Fixes: https://snyk.io/vuln/npm:request:20160119. Thanks to @benmag1 for the PR.
• Add node 6 to the test matrix

2.4.5 (2016-02-10)

• Fix some broken links

2.4.4 (2016-02-10)

• Update repository references to springernature
• Update the license

2.4.3 (2015-11-09)

• Add Node.js 5.0 support

2.4.2 (2015-09-14)

• Add Node.js 4.0 support

2.4.1 (2015-09-08)

• Update dependencies
• Run JavaScript through JSCS
• Add code coverage reporting

2.4.0 (2015-07-13)

• Make params an optional argument across the library
• Output more useful error messages

2.3.1 (2015-07-07)

• Update dependencies

2.3.0 (2015-05-18)

• Add logging options
• Add a timeout option
• Documentation improvements
• General refactoring

2.2.0 (2015-04-27)

• Make the client compatible with the API
• Send a sensible user-agent header
• Handle non-JSON or invalid responses properly
• Documentation improvements

2.1.0 (2014-07-02)

• Switch to the MIT license

2.0.0 (2014-06-23)

• Initial release