@circulare/feature-flag


This library wraps the intended usage of or feature-flag API

This library is intended to be used in an environment with user authentication

Getting Started

This library is available as a UMD package on NPM named @circulare/feature-flag. To install into a project, use a front-end packager such as Browserify or Webpack:

``sh
npm install --save @circulare/feature-flag
`

You can then require the lib like a standard Node.js module:

Usage

The lib is intended to be used on the browser with an already authenticated user. If thats not the case, the init function will throw an error: User is not authenticated

`javascript
import featureFlag from '@circulare/feature-flag';

const userFeatureFlagChecker = featureFlag.init('DOMAIN');

userFeatureFlagChecker.checkAccess('FF name'); // true | false
`

The lib keeps the user access flags in memory after init is called, to reload the flags you need to call init again creating a new instance of userFeatureFlagChecker`.

The same must be done in the case of changing users, deleting the old checker when the user logs-out and creating a new one when the user logs-in.

API Reference

FeatureFlag

- init(domain) – Returns a new instance instance of a featureFlagChecker for the currently logged user
- domain - Domain that should be used to make the request call to fetch the access flags

userFeatureFlagChecker

- checkAccess(featureName) – Returns wether the user has access to a feature or not.
- featureName:string - Name of the feature to be checked for access.