Javascript (Web)

Installation

Install the provider and the OpenFeature server SDK:

npm install @openfeature/web-sdk @hyphen/openfeature-web-provider

Setup and Initialization

To begin using the Hyphen Provider, follow these steps:

Import the required modules.
Configure the provider with your publicKey and application options.
Register the provider with OpenFeature.

import { OpenFeature } from '@openfeature/web-sdk';  
import { HyphenProvider, type HyphenProviderOptions } from '@hyphen/openfeature-web-provider';

const publicKey = "your-public-key-here";

const options: HyphenProviderOptions = {  
  application: 'your-application-name',  
  environment: 'production',  
};

await OpenFeature.setProviderAndWait(new HyphenProvider(publicKey, options));

Context

Use OpenFeature.setContext to configure the required context for feature targeting evaluations, incorporating user or application context.

const context: HyphenEvaluationContext = {  
  targetingKey: 'user-123',  
  ipAddress: '203.0.113.42',  
  customAttributes: {  
    subscriptionLevel: 'premium',  
    region: 'us-east',  
  },  
  user: {  
    id: 'user-123',  
    email: '[email protected]',  
    name: 'John Doe',  
    customAttributes: {  
      role: 'admin',  
    },  
  },  
};

OpenFeature.setContext(context);

Feature Evaluation

Use the OpenFeature.getClient() to evaluate feature flags in your application.

const client = OpenFeature.getClient();
const isEnabled = client.getBooleanDetails('your-flag-key', false);
console.log('isEnabled', isEnabled) // true or false

Configuration

Options

Option	Type	Description
`application`	string	The application id or alternate ID.
`environment`	string	The environment in which your application is running (e.g., `production`, `staging`).
`enableToggleUsage`	boolean	Enable or disable the logging of toggle usage (telemetry).

Context

Provide an EvaluationContext to pass contextual data for feature evaluation.

Context Fields

Field	Type	Description
`targetingKey`	`string`	The key used for caching the evaluation response.
`ipAddress`	`string`	The IP address of the user making the request.
`customAttributes`	`Record<string, any>`	Custom attributes for additional contextual information.
`user`	`object`	An object containing user-specific information for the evaluation.
`user.id`	`string`	The unique identifier of the user.
`user.email`	`string`	The email address of the user.
`user.name`	`string`	The name of the user.
`user.customAttributes`	`Record<string, any>`	Custom attributes specific to the user.