https://github.com/cloudbees-oss/cloudbees-openfeature-provider-node

https://github.com/cloudbees-oss/cloudbees-openfeature-provider-node

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cloudbees-oss/cloudbees-openfeature-provider-node
• Owner: cloudbees-oss
• License: apache-2.0
• Created: 2022-09-07T11:53:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-10-21T05:05:17.000Z (5 months ago)
• Last Synced: 2025-10-26T17:57:07.373Z (5 months ago)
• Language: TypeScript
• Size: 275 KB
• Stars: 1
• Watchers: 9
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CloudBees Feature Management provider for OpenFeature

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![a](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1)

[![OpenFeature Specification](https://img.shields.io/static/v1?label=OpenFeature%20Specification&message=v0.5.1&color=yellow)](https://github.com/open-feature/spec/tree/v0.5.1)

[![OpenFeature SDK](https://img.shields.io/static/v1?label=OpenFeature%20SDK&message=v1.0.0&color=green)](https://github.com/open-feature/js-sdk/tree/v1.0.0)

[![npm version](https://badge.fury.io/js/cloudbees-openfeature-provider-node.svg)](https://badge.fury.io/js/cloudbees-openfeature-provider-node)

[![CloudBees Rox SDK](https://img.shields.io/static/v1?label=Rox%20SDK&message=v5.4.1&color=green)](https://www.npmjs.com/package/rox-node)

[![Known Vulnerabilities](https://snyk.io/test/github/rollout/cloudbees-openfeature-provider-node/badge.svg)](https://snyk.io/test/github/rollout/cloudbees-openfeature-provider-node)

This is the [CloudBees](https://www.cloudbees.com/products/feature-management) provider implementation for [OpenFeature](https://openfeature.dev/) for the [Javascript SDK](https://github.com/open-feature/js-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

```bash

npm install cloudbees-openfeature-provider-node

```

or

```bash

yarn add cloudbees-openfeature-provider-node

```

### Confirm peer dependencies are installed

```bash

npm install @openfeature/js-sdk

```

or

```bash

yarn add @openfeature/js-sdk

```

### Configuration

Follow the instructions on the [Javascript SDK project](https://github.com/open-feature/js-sdk) for how to use the Javascript SDK.

You can configure the CloudBees provider by doing the following:

```typescript

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);

```