!Hyphen AI


Hyphen Browser SDK

The Hyphen Browser SDK is used as a base library to get evaluations and works for browsers and the base for javascript libraries such as react, vuejs, svelte, etc . For the full featured nodejs sdk use @hyphen/sdk

Table of Contents

- Installation
- Usage
- Basic Setup
- Using Helper Methods
- Boolean Toggles
- String Toggles
- Number Toggles
- Object Toggles
- Using the Generic get() Method
- Context Override
- Browser Integration Example
- Using ES Modules
- Using jsDelivr CDN
- API Reference
- Constructor Options
- Helper Methods
- Contributing
- License and Copyright

Installation

Install the package using npm, yarn, or pnpm:

``bash
npm install @hyphen/browser-sdk
`

For browser usage via CDN:

`html

`

Usage

Basic Setup

`javascript
import { Toggle } from '@hyphen/browser-sdk';

// Initialize the Toggle client
const toggle = new Toggle({
publicApiKey: 'public_your-api-key-here',
applicationId: 'your-app-id',
environment: 'production', // or 'development'
defaultContext: {
targetingKey: 'user-123',
user: {
id: 'user-123',
email: 'user@example.com',
name: 'John Doe'
}
}
});
`

Using Helper Methods

The SDK provides type-safe helper methods for common data types:

$3

`javascript
const isFeatureEnabled = await toggle.getBoolean('feature-flag', false);
if (isFeatureEnabled) {
console.log('Feature is enabled!');
}
`

$3

`javascript
const welcomeMessage = await toggle.getString('welcome-message', 'Hello World');
document.getElementById('welcome').textContent = welcomeMessage;
`

$3

`javascript
const maxRetries = await toggle.getNumber('max-retries', 3);
const timeout = await toggle.getNumber('api-timeout', 5000);
`

$3

`javascript
const config = await toggle.getObject('app-config', { theme: 'light' });
console.log('App configuration:', config);
`

Using the Generic get() Method

`javascript
// Generic method with type parameter
const feature = await toggle.get('feature-toggle', false);
const settings = await toggle.get