Package Exports

@harnessio/ff-javascript-client-sdk

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@harnessio/ff-javascript-client-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Harness CF Client SDK for JavaScript

Basic library for integrating CF into javascript applications.

Install

npm i @harnessio/ff-javascript-client-sdk

yarn add @harnessio/ff-javascript-client-sdk

Usage

import { initialize, Event } from '@harnessio/ff-javascript-client-sdk'

Initialize SDK with api key and target information.

// Replace with your SDK Key
const FF_SDK_KEY = "2c2a12a1-6599-406e-96c4-031a51c8a51b"

const cf = initialize(FF_SDK_KEY, {
    identifier: YOUR-TARGET-IDENTIFIER,      // Target identifier
    name: YOUR-TARGET-NAME,                  // Optional target name
    attributes: {                            // Optional target attributes
      email: 'sample@sample.com'
    }
  }, {
    baseUrl: 'http://40.20.100.200/api/1.0', // Replace with your Feature Flags server
  });

Listening to events from the `cf` instance.

cf.on(Event.READY, flags => {
  // Event happens when connection to server is established
  // flags contains all evaluations against SDK key
})

cf.on(Event.CHANGED, flagInfo => {
  // Event happens when a changed event is pushed
  // flagInfo contains information about the updated feature flag
})

cf.on(Event.DISCONNECTED, () => {
  // Event happens when connection is disconnected
})

cf.on(Event.ERROR, () => {
  // Event happens when connection some error has occurred
})

Getting value for a particular feature flag

const value = cf.variation("dark-theme", false)

Cleaning up

Remove a listener of an event by cf.off.

cf.off(Event.ERROR, YOUR-CLOSURE)

Remove all listeners:

cf.off()

On closing your application, call cf.close() to close the stream.

cf.close();

License

Apache version 2.

@harnessio/ff-javascript-client-sdk