Hyphen Node.js SDK

The Hyphen Node.js SDK is a JavaScript library that allows developers to easily integrate Hyphen's feature flag service Toggle, secret management service ENV, and geo information service Net Info into their Node.js applications.

Installation

To install the Hyphen Node.js SDK, you can use npm or yarn. Run the following command in your terminal:

npm install @hyphen/sdk

Basic Usage with Hyphen

There are many ways to use the Hyphen Node.js SDK. Because of this we have created examples for each of the different ways in each secton of the documentation. To get started, you can create an instance of the Hyphen class and use its methods to interact with the various services.

import { Hyphen } from '@hyphen/sdk';

const hyphen = new Hyphen({
	publicApiKey: 'your_public_api_key',
	applicationId: 'your_application_id',
});
const result = await hyphen.toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

You can also use netInfo to access the network information service.

import { Hyphen, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const hyphen = new Hyphen({
	publicApiKey: 'your_public_api_key',
	toggle: {
		applicationId: 'your_application_id',
		context: context,
	},
});
const result = await hyphen.toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

You can also use netInfo to access the network information service.

import { Hyphen } from '@hyphen/sdk';

const hyphen = new Hyphen({
	apiKey: 'your_api_key',
});
const result = await hyphen.netInfo.getIpInfo('8.8.8.8');
console.log('Geo IP information:', result);

If you need to set the apiKey or publicApiKey after initializing Hyphen you can do so and it will cascade the setting to the individual services:

import { Hyphen } from '@hyphen/sdk';

const hyphen = new Hyphen();
hyphen.apiKey = 'your_api_key';
const result = await hyphen.netInfo.getIpInfo('8.8.8.8');
console.log('Geo IP information:', result);

Finally, error, warn, and info emitters are enabled from each of the services and you can access them by doing the following example with error:

import { Hyphen } from '@hyphen/sdk';

const hyphen = new Hyphen({ apiKey: 'your_api_key'});

hyphen.on('error', (error) => {
	console.log(error);
});

const result = await hyphen.netInfo.getIpInfo('8.8.8.8');
console.log('Geo IP information:', result);

The rest of the examples for each service show you accessing the service instance directly.

Toggle - Feature Flag Service

Toggle is our feature flag service that allows you to control the rollout of new features to your users. You can access your feature flags using the Toggle class.

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
};

const toggle = new Toggle(toggleOptions);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);

console.log('Boolean toggle value:', result); // true

if you want to set the context you can do it like this:

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
};

const toggle = new Toggle(toggleOptions);

toggle.setContext(context);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);

console.log('Boolean toggle value:', result); // true

if you would like to override the context for a single request you can do it like this:

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
};

const overrideContext: ToggleContext = {
	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',
		},
	},
};

const toggle = new Toggle(toggleOptions);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false, { context: overrideContext });

console.log('Boolean toggle value:', result); // true

Toggle Options

Option	Type	Description
publicApiKey	`string`	The public API key for your Hyphen project. You can find this in the Hyphen dashboard.
applicationId	`string`	The application ID for your Hyphen project. You can find this in the Hyphen dashboard.
environment?	`string`	The environment for your Hyphen project such as `production`. Default uses `process.env.NODE_ENV`
context?	`ToggleContext`	The context object that contains the user and custom attributes. This is optional.
caching?	`{ ttl: number, generateCacheKeyFn: (context?: ToggleContext) => string}`	Whether to use the cache or not and a function to set the key. The `ttl` is in seconds

Toggle API

Method	Parameters	Description
setContext	`context: ToggleContext`	Set the context for the toggle. This is optional.
get	`key: string, defaultValue: T, options?: ToggleGetOptions`	Get the value of a toggle. This is a generic method that can be used to get any type from toggle.
getBoolean	`key: string, defaultValue: boolean, options?: ToggleGetOptions`	Get the value of a boolean toggle.
getNumber	`key: string, defaultValue: number, options?: ToggleGetOptions`	Get the value of a number toggle.
getString	`key: string, defaultValue: string, options?: ToggleGetOptions`	Get the value of a string toggle.
getObject	`key: string, defaultValue: any, options?: ToggleGetOptions`	Get the value of a object toggle.

Toggle Hooks

The following hooks are available for Toggle:

Hook	object	Description
beforeGetBoolean	`{ key: string, defaultValue:boolean, options?: ToggleGetOptions }`	Called before the boolean toggle is fetched.
afterGetBoolean	`{ key: string, defaultValue:boolean, options?: ToggleGetOptions, result: boolean }`	Called after the boolean toggle is fetched.
beforeGetNumber	`{ key: string, defaultValue:number, options?: ToggleGetOptions }`	Called before the number toggle is fetched.
afterGetNumber	`{ key: string, defaultValue:number, options?: ToggleGetOptions, result: number }`	Called after the number toggle is fetched.
beforeGetString	`{ key: string, defaultValue:string, options?: ToggleGetOptions }`	Called before the string toggle is fetched.
afterGetString	`{ key: string, defaultValue:string, options?: ToggleGetOptions, result: string }`	Called after the string toggle is fetched.
beforeGetObject	`{ key: string, defaultValue:any, options?: ToggleGetOptions }`	Called before the object toggle is fetched.
afterGetObject	`{ key: string, defaultValue:any, options?: ToggleGetOptions, result: any }`	Called after the object toggle is fetched.

You can use the hooks to modify the request or the response. For example, you can use the beforeGetBoolean hook to log the request before it is sent to the server.

import { Toggle, ToggleHooks, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
};

const toggle = new Toggle(toggleOptions);

toggle.onHook(ToggleHooks.beforeGetBoolean, (data) => {
  console.log('Before get boolean toggle:', data); // { key: 'hyphen-sdk-boolean', defaultValue: false }
});

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);

console.log('Boolean toggle value:', result); // true

Toggle Error Handling

The SDK provides a way to handle errors that occur during the toggle request. You can use the .on method to handle errors globally.

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
};

const toggle = new Toggle(toggleOptions);
toggle.on('error', (error) => {
  console.error('Error fetching toggle:', error);
});

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

If you would like to have the errors thrown you can use the throwErrors option in the constructor:

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
  throwErrors: true,
};

const toggle = new Toggle(toggleOptions);

try {
  const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
  console.log('Boolean toggle value:', result); // true
} catch (error) {
  console.error('Error fetching toggle:', error);
}

Toggle Caching

The SDK supports caching of toggle values to improve performance and reduce the number of requests made to the server. You can enable caching by providing a caching option in the constructor.

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
  uris: [
	'https://your-self-hosted-horizon-url',
  ],
  caching: {
	ttl: 60, // Cache for 60 seconds
};

const toggle = new Toggle(toggleOptions);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

If you want to use a custom cache key generation function, you can provide a generateCacheKeyFn function in the caching option:

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
  uris: [
	'https://your-self-hosted-horizon-url',
  ],
  caching: {
	ttl: 60, // Cache for 60 seconds
	generateCacheKeyFn: (context) => {
		return `toggle-${context?.targetingKey || 'default'}-hyphen-sdk-boolean`;
	},
  },
};

const toggle = new Toggle(toggleOptions);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

Toggle Environment Variables

You can also use environment variables to set the publicApiKey and applicationId. This is useful for keeping your API keys secure and not hardcoding them in your code. To do this just set your .env file with the following variables:

HYPHEN_PUBLIC_API_KEY=your_public_api_key
HYPHEN_APPLICATION_ID=your_application_id

On initialization of the Toggle class, the SDK will automatically check for these environment variables and use them if they are set. If they are not set, you will need to provide them in the constructor.

Toggle Self-Hosted

Toggle uses Horizon to fetch the feature flags. If you are using a self-hosted version of Hyphen you can use the uris option in the constructor to set the url of your self-hosted version:

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
  uris: [
	'https://your-self-hosted-horizon-url',
  ],
};

const toggle = new Toggle(toggleOptions);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

If you want to use your self-hosted version of Horizon as a primary and fallback to our hosted version you can do it like this:

import { Toggle, ToggleContext } from '@hyphen/sdk';

const context: ToggleContext = {
	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',
		},
	},
};

const toggleOptions = {
  publicApiKey: 'your_public_api_key',
  applicationId: 'your_application_id',
  context: context,
  uris: [
	'https://your-self-hosted-horizon-url',
	'https://toggle.hyphen.cloud',
  ],
};

const toggle = new Toggle(toggleOptions);

const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
console.log('Boolean toggle value:', result); // true

ENV - Secret Management Service

Hyphens secret management service known as ENV allows you to manage your environment variables in a secure way. The Hyphen Node.js SDK provides a simple way to access your environment variables.

Loading Environment Variables

To load your environment variables, you can use the env() function from the SDK. This function will automatically load your environment variables from the .env file and then override them with the environment based environment file if it exists (ex: .env.development). This is useful for managing different environments such as development, staging, and production.

The following override path is:

.env -> .env.local -> .env.<environment> -> .env.<environment>.local

Here is an example of how to use the env() function:

import { env } from '@hyphen/sdk';

//load your default environment variables and envrionment variables
env();

If your environment variables are not stored in the root of your project you can specify the path to your .env file:

import { env } from '@hyphen/sdk';
//load your default environment variables and envrionment variables
env({ path: '/path/to/your/env/files/' });

You can also specify the environment variables to load by passing an array of variable names:

import { env } from '@hyphen/sdk';
//load your default environment variables and envrionment variables
env({ environment: 'development' });

if you want to turn off the local environment variables you can do it like this:

import { env } from '@hyphen/sdk';
//load your default environment variables and envrionment variables
env({ local: false });

Net Info - Geo Information Service

The Hyphen Node.js SDK also provides a NetInfo class that allows you to fetch geo information about an IP address. This can be useful for debugging or logging purposes. You can read more about it:

Website
https://net.info - webservice uri used by the SDK
Quick Start Guide

To use the NetInfo class, you can do the following:

import { NetInfo } from '@hyphen/sdk';
const netInfo = new NetInfo({
  apiKey: 'your_api_key',
});

const ipInfo = await netInfo.getIpInfo('8.8.8.8');
console.log('IP Info:', ipInfo);

If you want to fetch information for multiple IP addresses, you can do it like this:

import { NetInfo } from '@hyphen/sdk';
const netInfo = new NetInfo({
  apiKey: 'your_api_key',
});
const ips = ['8.8.8.8', '1.1.1.1'];
const ipInfos = await netInfo.getIpInfos(ips);
console.log('IP Infos:', ipInfos);

You can also set the API key using the HYPHEN_API_KEY environment variable. This is useful for keeping your API key secure and not hardcoding it in your code.

Link - Short Code Service

The Hyphen Node.js SDK also provides a Link class that allows you to create and manage short codes. This can be useful for generating short links for your application.

Creating a Short Code

To create a short code, you can use the createShortCode method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const longUrl = 'https://hyphen.ai';
const domain = 'test.h4n.link';
const options = {
  tags: ['sdk-test', 'unit-test'],
};
const response = await link.createShortCode(longUrl, domain, options);
console.log('Short Code Response:', response);

Updating a Short Code

To update a short code, you can use the updateShortCode method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code you want to update
const longUrl = 'https://hyphen.ai/updated';
const options = {
  title: 'Updated Short Code',
  tags: ['sdk-test', 'unit-test'],
  long_url: longUrl,
};

const updateResponse = await link.updateShortCode(code, options);
console.log('Update Short Code Response:', updateResponse);

Getting a Short Code

To get a short code, you can use the getShortCode method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code you want to get
const response = await link.getShortCode(code);
console.log('Get Short Code Response:', response);

Getting Short Codes

To get a list of short codes, you can use the getShortCodes method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const title = 'My Short Codes'; // Optional title to filter short codes
const tags = ['sdk-test', 'unit-test']; // Optional tags to filter short codes
const response = await link.getShortCodes(title, tags);
console.log('Get Short Codes Response:', response);

Getting all Organization Tags

To get all tags for your organization, you can use the getTags method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const response = await link.getTags();
console.log('Get Tags Response:', response);

Get Short Code Stats

To get the stats for a short code, you can use the getShortCodeStats method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code
const startDate = new Date('2023-01-01'); // Optional start date for the stats
const endDate = new Date('2023-12-31'); // Optional end date for the stats
const response = await link.getShortCodeStats(code, startDate, endDate);
console.log('Get Short Code Stats Response:', response);

Deleting a Short Code

if you want to delete a short code you can do it like this:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code you want to delete
const response = await link.deleteShortCode(code);
console.log('Delete Short Code Response:', response);

Creating a QR Code from a Short Code

To create a QR code from a short code, you can use the createQrCode method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code you want to create a QR code for
const response = await link.createQrCode(code);
console.log('Create QR Code Response:', response);

There are options that you can pass in to the createQrCode method to customize the QR code:

export type CreateQrCodeOptions = {
	/**
	 * The title of the QR code. This is used for display purposes.
	 * @default undefined
	 */
	title?: string;
	/**
	 * The background color of the QR code. This is a hex color code.
	 * @default '#ffffff'
	 */
	backgroundColor?: string;
	/**
	 * The color of the QR code. This is a hex color code.
	 * @default '#000000'
	 */
	color?: string;
	/**
	 * The size of the QR code. This can be 'small', 'medium', or 'large'.
	 * @default QrSize.MEDIUM
	 */
	size?: QrSize;
	/**
	 * The logo to include in the QR code. This should be a base64 encoded string.
	 * @default undefined
	 */
	logo?: string;
};

Get a QR Code By Id

To get a specific QR code by its ID, you can use the getQrCode method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code
const qr = 'qr_1234567890'; // It is the ID of the QR code you want to retrieve
const response = await link.getQrCode(code, qr);
console.log('Get QR Code Response:', response);

Get QR Codes for a Short Code

To get all QR codes for a short code, you can use the getQrCodes method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code
const response = await link.getQrCodes(code);
console.log('Get QR Codes Response:', response);

Deleting a QR Code

To delete a QR code, you can use the deleteQrCode method:

import { Link } from '@hyphen/sdk';
const link = new Link({
  organizationId: 'your_organization_id',
  apiKey: 'your_api_key',
});
const code = 'code_1234567890'; // It is the code identifier for the short code
const qr = 'qr_1234567890'; // It is the ID of the QR code you want to delete
const response = await link.deleteQrCode(code, qr);
console.log('Delete QR Code Response:', response);

Contributing

We welcome contributions to the Hyphen Node.js SDK! If you have an idea for a new feature, bug fix, or improvement, please follow these steps:

Fork the repository.
Create a new branch for your feature or bug fix.
Install pnpm by running npm install -g pnpm if you don't have it already.
Run the installation and tests to ensure everything is working correctly pnpm i && pnpm test.
Make your changes and commit them with a clear message. In the following format:
- feat: <describe the feature>
- fix: <describe the bug fix>
- chore: updgrading xxx to version x.x.x
Push your changes to your forked repository.
Create a pull request to the main repository.
Describe your changes and why they are necessary.

Testing Your Changes

To test your changes locally you will need to create an account on Hyphen and do the following:

Create a new project in the Hyphen dashboard. This will give you a project ID and an Public API key.
On the project please add the following toggles:

Name	Type	Value
hyphen-sdk-boolean	boolean	true
hyphen-sdk-number	number	42
hyphen-sdk-string	string	"Hyphen!"
hyphen-sdk-json	json	`{ "id": "Hello World!"}`

Then, create a new application in the project. This will give you an application ID.

Once you have created the project, added the toggles, and created your application you can run the tests then create an .env file in the root of the project with the following content:

HYPHEN_PUBLIC_API_KEY=your_public_api_key
HYPHEN_API_KEY=your_api_key
HYPHEN_APPLICATION_ID=your_project_id
HYPHEN_LINK_DOMAIN=your_link_domain
HYPHEN_ORGANIZATION_ID=your_organization_id

A bit more information about the environment variables:

Variable	Example Value	Description
HYPHEN_PUBLIC_API_KEY	`public_api_key`	The public API key for your Hyphen project. You can find this in the Hyphen dashboard.
HYPHEN_API_KEY	`api_key`	The API key for your Hyphen project. You can find this in the Hyphen dashboard.
HYPHEN_APPLICATION_ID	`application_id`	The application ID for your Hyphen project. You can find this in the Hyphen dashboard.
HYPHEN_LINK_DOMAIN	`test.h4n.link`	The domain for the Link service. This is used for generating links.
HYPHEN_ORGANIZATION_ID	`org_668575c0e169cde974a5c76a`

Then run the tests with the following command:

pnpm i && pnpm test

Name		Name	Last commit message	Last commit date
Latest commit History 228 Commits
.github		.github
src		src
test		test
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
biome.json		biome.json
logo.png		logo.png
package.json		package.json
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Hyphen Node.js SDK

Table of Contents

Installation

Basic Usage with Hyphen

Toggle - Feature Flag Service

Toggle Options

Toggle API

Toggle Hooks

Toggle Error Handling

Toggle Caching

Toggle Environment Variables

Toggle Self-Hosted

ENV - Secret Management Service

Loading Environment Variables

Net Info - Geo Information Service

Link - Short Code Service

Creating a Short Code

Updating a Short Code

Getting a Short Code

Getting Short Codes

Getting all Organization Tags

Get Short Code Stats

Deleting a Short Code

Creating a QR Code from a Short Code

Get a QR Code By Id

Get QR Codes for a Short Code

Deleting a QR Code

Contributing

Testing Your Changes

License and Copyright

About

Uh oh!

Releases 16

Uh oh!

Languages

License

Hyphen/nodejs-sdk

Folders and files

Latest commit

History

Repository files navigation

Hyphen Node.js SDK

Table of Contents

Installation

Basic Usage with Hyphen

Toggle - Feature Flag Service

Toggle Options

Toggle API

Toggle Hooks

Toggle Error Handling

Toggle Caching

Toggle Environment Variables

Toggle Self-Hosted

ENV - Secret Management Service

Loading Environment Variables

Net Info - Geo Information Service

Link - Short Code Service

Creating a Short Code

Updating a Short Code

Getting a Short Code

Getting Short Codes

Getting all Organization Tags

Get Short Code Stats

Deleting a Short Code

Creating a QR Code from a Short Code

Get a QR Code By Id

Get QR Codes for a Short Code

Deleting a QR Code

Contributing

Testing Your Changes

License and Copyright

About

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 16

Uh oh!

Languages