cloudbees-openfeature-provider-node

cloudbees-openfeature-provider-node

This is the CloudBees provider implementation for OpenFeature for the Javascript SDK.

OpenFeature provides a vendor-agnostic abstraction layer on Feature Flag management.

This provider allows the use of CloudBees Feature Management as a backend for Feature Flag configurations.

Requirements

• node 14 or greater

Installation

Add it to your build

npm install cloudbees-openfeature-provider-node

or

yarn add cloudbees-openfeature-provider-node

Confirm peer dependencies are installed

npm install @openfeature/js-sdk

or

yarn add @openfeature/js-sdk

Configuration

Follow the instructions on the Javascript SDK project for how to use the Javascript SDK.

You can configure the CloudBees provider by doing the following:

import {OpenFeature} from '@openfeature/js-sdk';
import {CloudbeesProvider} from 'cloudbees-openfeature-provider-node'

const appKey = 'INSERT_APP_KEY_HERE'
OpenFeature.setProvider(await CloudbeesProvider.build(appKey));
const client = OpenFeature.getClient();
const value = await client.getBooleanValue('enabled-new-feature', false);

Changelog

1.0.0 (2022-10-20)

Miscellaneous Chores

• Update readme as well (06c9a5a)