README.md

obsolete

We archived this repository as no one was maintaining it, and the API was simple enough that most people were just using their own HTTP clients to talk to it, and avoiding an extra dependency. Also, we don’t use Node as a general rule for backend services, which didn’t help with lust for maintaining it.

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.