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.

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
• Execution Context - API Key Validation
• Link - Short Code Service
  • Creating a Short Code
  • Updating a Short Code
  • Getting a Short Code
  • Getting Short Codes
  • Getting all Organization Tags
  • Getting Short Code Stats
  • Deleting a Short Code
  • Creating a QR Code from a Short Code
  • Get QR Codes for a Short Code
  • Deleting a QR Code
• Migrating to v3
• Contributing
• Testing Your Changes
• License and Copyright

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';consthyphen=newHyphen({publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',});constresult=awaithyphen.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';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consthyphen=newHyphen({publicApiKey: 'your_public_api_key',toggle: {applicationId: 'your_application_id',context: context,},});constresult=awaithyphen.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';consthyphen=newHyphen({apiKey: 'your_api_key',});constresult=awaithyphen.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';consthyphen=newHyphen();hyphen.apiKey='your_api_key';constresult=awaithyphen.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';consthyphen=newHyphen({apiKey: 'your_api_key'});hyphen.on('error',(error)=>{console.log(error);});constresult=awaithyphen.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.

Breaking Changes (v2.0)

⚠️ The Toggle API has been simplified in v2.0. Please review the changes below:

Removed Methods

• ❌ setContext(context) - Use property setter instead: toggle.defaultContext = context
• ❌ setPublicApiKey(key) - Use property setter instead: toggle.publicApiKey = key
• ❌ getClient() - No longer needed, use the Toggle instance directly

Removed Options

• ❌ throwErrors - Errors are now always emitted via events and default values are returned

Changed Behavior

• Hooks removed from convenience methods (getBoolean, getString, etc.)
• Hooks now only available via event system (toggle.on('error', ...))
• All toggle methods now return default values on error instead of throwing

Migration Guide

Before (v1.x):

consttoggle=newToggle(options);toggle.setContext(context);constclient=awaittoggle.getClient();

After (v2.0):

consttoggle=newToggle(options);toggle.defaultContext=context;// Use toggle directly - no getClient() needed

import{Toggle,ToggleContext}from'@hyphen/sdk';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,};consttoggle=newToggle(toggleOptions);constresult=awaittoggle.getBoolean('hyphen-sdk-boolean',false);console.log('Boolean toggle value:',result);// true

You can also set or update the context after initialization using the defaultContext property:

import{Toggle,ToggleContext}from'@hyphen/sdk';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',};consttoggle=newToggle(toggleOptions);// Set the default contexttoggle.defaultContext=context;constresult=awaittoggle.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';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,};constoverrideContext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggle=newToggle(toggleOptions);constresult=awaittoggle.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. Must start with "public_".
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. Defaults to development if not provided.
defaultContext?	ToggleContext	The default context to use when one is not passed to getter methods. Can be overridden per-request using the GetOptions parameter.
horizonUrls?	string[]	Array of Horizon endpoint URLs for load balancing and failover. If not provided, defaults to Hyphen's hosted service.
defaultTargetKey?	string	Default targeting key to use if one cannot be derived from context. If not provided, a random key will be generated.
cache?	Cacheable	Cacheable instance for caching fetch operations. See @cacheable/cacheable for more information.

Toggle API

Methods

Method	Parameters	Description
get	key: string, defaultValue: T, options?: GetOptions	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?: GetOptions	Get the value of a boolean toggle.
getNumber	key: string, defaultValue: number, options?: GetOptions	Get the value of a number toggle.
getString	key: string, defaultValue: string, options?: GetOptions	Get the value of a string toggle.
getObject	key: string, defaultValue: T, options?: GetOptions	Get the value of an object toggle.
fetch	path: string, payload?: unknown, options?: FetchOptions	Make a raw HTTP POST request to Horizon endpoints with automatic authentication and load balancing.

Properties (Getters/Setters)

Property	Type	Description
publicApiKey	string | undefined	Get or set the public API key.
defaultContext	ToggleContext | undefined	Get or set the default context for toggle evaluations.
applicationId	string | undefined	Get or set the application ID.
environment	string | undefined	Get or set the environment.
horizonUrls	string[]	Get or set the Horizon endpoint URLs for load balancing.
defaultTargetingKey	string	Get or set the default targeting key.
organizationId	string | undefined	Get the organization ID (read-only, extracted from public key).
cache	Cacheable	Get or set the Cacheable instance used for caching fetch operations.

GetOptions

The GetOptions type is used in toggle getter methods:

typeGetOptions={context?: ToggleContext;// Override the default context for this requestcache?: boolean;// Whether to use caching (if configured)};

Toggle Hooks

Toggle extends the Hookified class, which provides a flexible hook system for intercepting and modifying behavior. You can register hooks using the onHook() method.

Note: Hooks are currently only implemented on the base get<T>() method and event emitters.

Available Hooks

You can listen to errors using the error event:

import{Toggle}from'@hyphen/sdk';consttoggle=newToggle({publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',});toggle.on('error',(error)=>{console.error('Toggle error:',error);});constresult=awaittoggle.getBoolean('my-feature',false);

Custom Hooks (Advanced)

Since Toggle extends Hookified, you can create custom hooks for advanced use cases:

import{Toggle}from'@hyphen/sdk';consttoggle=newToggle({publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',});// Register a custom hooktoggle.onHook('myCustomHook',(data)=>{console.log('Custom hook called:',data);});// Trigger the hook (in your own code)awaittoggle.hook('myCustomHook',{someData: 'value'});

Toggle Error Handling

The SDK provides a way to handle errors that occur during toggle requests. You can use the .on method to listen for errors globally. When an error occurs, the toggle methods will return the default value provided.

import{Toggle,ToggleContext}from'@hyphen/sdk';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,};consttoggle=newToggle(toggleOptions);toggle.on('error',(error)=>{console.error('Error fetching toggle:',error);});constresult=awaittoggle.getBoolean('hyphen-sdk-boolean',false);console.log('Boolean toggle value:',result);// Returns false (default) if error occurs

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';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,caching: {ttl: 60000,// Cache for 60 seconds (in milliseconds)},};consttoggle=newToggle(toggleOptions);constresult=awaittoggle.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';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,caching: {ttl: 60000,// Cache for 60 seconds (in milliseconds)generateCacheKeyFn: (context)=>{return`toggle-${context?.targetingKey||'default'}-hyphen-sdk-boolean`;},},};consttoggle=newToggle(toggleOptions);constresult=awaittoggle.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 horizonUrls (or uris for backward compatibility) option in the constructor to set the URL of your self-hosted version:

import{Toggle,ToggleContext}from'@hyphen/sdk';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,horizonUrls: ['https://your-self-hosted-horizon-url',],};consttoggle=newToggle(toggleOptions);constresult=awaittoggle.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';constcontext: ToggleContext={targetingKey: 'user-123',ipAddress: '203.0.113.42',customAttributes: {subscriptionLevel: 'premium',region: 'us-east',},user: {id: 'user-123',email: 'john.doe@example.com',name: 'John Doe',customAttributes: {role: 'admin',},},};consttoggleOptions={publicApiKey: 'your_public_api_key',applicationId: 'your_application_id',context: context,horizonUrls: ['https://your-self-hosted-horizon-url','https://toggle.hyphen.cloud',],};consttoggle=newToggle(toggleOptions);constresult=awaittoggle.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 variablesenv();

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 variablesenv({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 variablesenv({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 variablesenv({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';constnetInfo=newNetInfo({apiKey: 'your_api_key',});constipInfo=awaitnetInfo.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';constnetInfo=newNetInfo({apiKey: 'your_api_key',});constips=['8.8.8.8','1.1.1.1'];constipInfos=awaitnetInfo.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.

Execution Context - API Key Validation

The getExecutionContext function validates an API key and returns information about the authenticated user, organization, and request context. This is useful for verifying API keys and getting user/organization details.

Basic Usage

import{getExecutionContext}from'@hyphen/sdk';constcontext=awaitgetExecutionContext('your-api-key');console.log('User:',context.user?.name);console.log('Organization:',context.member?.organization?.name);console.log('IP Address:',context.ipAddress);console.log('Location:',context.location?.city,context.location?.country);

Options

Option	Type	Description
organizationId	string	Optional organization ID to scope the context request
baseUri	string	Custom API base URI (defaults to https://api.hyphen.ai)
cache	Cacheable	Cacheable instance for caching requests

With Organization ID

If you need to get context for a specific organization:

import{getExecutionContext}from'@hyphen/sdk';constcontext=awaitgetExecutionContext('your-api-key',{organizationId: 'org_123456789',});console.log('Organization:',context.organization?.name);

With Caching

To enable caching of execution context requests:

import{Cacheable}from'cacheable';import{getExecutionContext}from'@hyphen/sdk';constcache=newCacheable({ttl: 60000});// Cache for 60 secondsconstcontext=awaitgetExecutionContext('your-api-key',{
cache,});console.log('User:',context.user?.name);

Return Type

The function returns an ExecutionContext object with the following properties:

Property	Type	Description
request	object	Request metadata (id, causationId, correlationId)
user	object	User info (id, name, rules, type)
member	object	Member info with nested organization
organization	object	Organization info (id, name)
ipAddress	string	The IP address of the request
location	object	Geo location (country, region, city, lat, lng, postalCode, timezone)

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.

• Website
• Guides
• API Reference

Creating a Short Code

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

import{Link}from'@hyphen/sdk';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constlongUrl='https://hyphen.ai';constdomain='test.h4n.link';constoptions={tags: ['sdk-test','unit-test'],};constresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short code you want to updateconstlongUrl='https://hyphen.ai/updated';constoptions={title: 'Updated Short Code',tags: ['sdk-test','unit-test'],long_url: longUrl,};constupdateResponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short code you want to getconstresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});consttitle='My Short Codes';// Optional title to filter short codesconsttags=['sdk-test','unit-test'];// Optional tags to filter short codesconstresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short codeconststartDate=newDate('2023-01-01');// Optional start date for the statsconstendDate=newDate('2023-12-31');// Optional end date for the statsconstresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short code you want to deleteconstresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short code you want to create a QR code forconstresponse=awaitlink.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:

exporttypeCreateQrCodeOptions={/** * 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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short codeconstqr='qr_1234567890';// It is the ID of the QR code you want to retrieveconstresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short codeconstresponse=awaitlink.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';constlink=newLink({organizationId: 'your_organization_id',apiKey: 'your_api_key',});constcode='code_1234567890';// It is the code identifier for the short codeconstqr='qr_1234567890';// It is the ID of the QR code you want to deleteconstresponse=awaitlink.deleteQrCode(code,qr);console.log('Delete QR Code Response:',response);

Migrating to v3

v3 upgrades the underlying event system to hookified v2. There are two breaking changes:

throwOnEmptyListeners now defaults to true

In v2, emitting events (error) without any registered listeners was silently ignored. In v3, this will throw an error by default. If your code emits events, you must register listeners:

consthyphen=newHyphen({apiKey: 'your-key'});// Register listeners before triggering operations that emit eventshyphen.on('error',(message)=>{console.error('Error:',message);});

If you want to restore the previous behavior where unhandled events are silently ignored, pass throwOnEmptyListeners: false in the options:

consthyphen=newHyphen({apiKey: 'your-key',throwOnEmptyListeners: false,});consttoggle=newToggle({publicApiKey: 'public_your-key',throwOnEmptyListeners: false,});

throwErrors option removed

The throwErrors option has been removed from BaseServiceOptions, HyphenOptions, and all service classes. Error throwing is now handled natively by hookified v2.

To get the previous throwErrors: true behavior, use throwOnEmitError: true instead:

// v2 (old)constnetInfo=newNetInfo({throwErrors: true});// v3 (new)constnetInfo=newNetInfo({throwOnEmitError: true});

The throwErrors getter/setter on service instances has also been removed as you can use .throwOnEmitError getter/setter now.

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:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Install pnpm by running npm install -g pnpm if you don't have it already.

4. Run the installation and tests to ensure everything is working correctly pnpm i && pnpm test.

5. 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

6. Push your changes to your forked repository.

7. Create a pull request to the main repository.

8. 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:

1. Create a new project in the Hyphen dashboard. This will give you a project ID and an Public API key.
2. 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

License and Copyright

This project is licensed under the MIT License. See the LICENSE file for details. The copyright for this project is held by Hyphen, Inc. All rights reserved.