@hyphen/sdk 1.1.0 → 1.2.0

package/README.md

@@ -10,7 +10,6 @@
 The Hyphen Node.js SDK is a JavaScript library that allows developers to easily integrate Hyphen's feature flagging and experimentation capabilities into their Node.js applications. With this SDK, you can manage feature flags more effectively, enabling you to control the rollout of new features and conduct A/B testing with ease.
 
 # Table of Contents
-- [Hyphen Node.js SDK](#hyphen-nodejs-sdk)
 - [Installation](#installation)
 - [Basic Usage](#basic-usage)
 - [Toggle](#toggle)

package/dist/index.cjs

@@ -57,61 +57,141 @@ var Toggle = class extends import_hookified.Hookified {
     __name(this, "Toggle");
   }
   _applicationId;
-  _publicKey;
+  _publicApiKey = "";
   _environment;
   _client;
   _context;
   _throwErrors = false;
   _uris;
+  /*
+   * Create a new Toggle instance. This will create a new client and set the options.
+   * @param {ToggleOptions}
+  */
   constructor(options) {
     super();
     this._applicationId = options.applicationId;
-    this._publicKey = options.publicKey;
+    this.setPublicApiKey(options.publicApiKey);
     this._environment = options.environment ?? import_node_process.default.env.NODE_ENV ?? "development";
     this._context = options.context;
     this._throwErrors = options.throwErrors ?? false;
     this._uris = options.uris;
   }
+  /**
+  * Get the application ID
+  * @returns {string}
+  */
   get applicationId() {
     return this._applicationId;
   }
+  /**
+  * Set the application ID
+  * @param {string} value
+  */
   set applicationId(value) {
     this._applicationId = value;
   }
-  get publicKey() {
-    return this._publicKey;
+  /**
+  * Get the public API key
+  * @returns {string}
+  */
+  get publicApiKey() {
+    return this._publicApiKey;
   }
-  set publicKey(value) {
-    this._publicKey = value;
+  /**
+  * Set the public API key
+  * @param {string} value
+  */
+  set publicApiKey(value) {
+    this.setPublicApiKey(value);
   }
+  /**
+  * Get the environment
+  * @returns {string}
+  */
   get environment() {
     return this._environment;
   }
+  /**
+  * Set the environment
+  * @param {string} value
+  */
   set environment(value) {
     this._environment = value;
   }
+  /**
+  * Get the throwErrors. If true, errors will be thrown in addition to being emitted.
+  * @returns {boolean}
+  */
   get throwErrors() {
     return this._throwErrors;
   }
+  /**
+  * Set the throwErrors. If true, errors will be thrown in addition to being emitted.
+  * @param {boolean} value
+  */
   set throwErrors(value) {
     this._throwErrors = value;
   }
+  /**
+  * Get the current context. This is the default context used. You can override this at the get function level.
+  * @returns {ToggleContext}
+  */
   get context() {
     return this._context;
   }
+  /**
+  * Set the context. This is the default context used. You can override this at the get function level.
+  * @param {ToggleContext} value
+  */
   set context(value) {
     this._context = value;
   }
+  /**
+  * Get the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+  * @returns {Array<string>}
+  */
   get uris() {
     return this._uris;
   }
+  /**
+  * Set the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+  * @param {Array<string>} value
+  */
   set uris(value) {
     this._uris = value;
   }
+  /**
+  * This is a helper function to set the public API key. It will check if the key starts with public_ and set it. If it
+  * does set it will also set the client to undefined to force a new one to be created. If it does not, 
+  * it will emit an error and console warning and not set the key. Used by the constructor and publicApiKey setter.
+  * @param key 
+  * @returns 
+  */
+  setPublicApiKey(key) {
+    if (!key.startsWith("public_")) {
+      this.emit("error", new Error("Public API key should start with public_"));
+      if (import_node_process.default.env.NODE_ENV !== "production") {
+        console.error("Public API key should start with public_");
+      }
+      return;
+    }
+    this._publicApiKey = key;
+    this._client = void 0;
+  }
+  /**
+  * Set the context. This is the default context used. You can override this at the get function level.
+  * @param {ToggleContext} context
+  */
   setContext(context) {
     this._context = context;
     this._client = void 0;
   }
+  /**
+  * Helper function to get the client. This will create a new client if one does not exist. It will also set the
+  * application ID, environment, and URIs if they are not set. This is used by the get function to get the client.
+  * This is normally only used internally.
+  * @returns {Promise<Client>}
+  */
   async getClient() {
     if (!this._client) {
       const options = {
@@ -119,11 +199,19 @@ var Toggle = class extends import_hookified.Hookified {
         environment: this._environment,
         horizonUrls: this._uris
       };
-      await import_server_sdk.OpenFeature.setProviderAndWait(new import_openfeature_server_provider.HyphenProvider(this._publicKey, options));
+      await import_server_sdk.OpenFeature.setProviderAndWait(new import_openfeature_server_provider.HyphenProvider(this._publicApiKey, options));
       this._client = import_server_sdk.OpenFeature.getClient(this._context);
     }
     return this._client;
   }
+  /**
+  * This is the main function to get a feature flag value. It will check the type of the default value and call the
+  * appropriate function. It will also set the context if it is not set.
+  * @param {string} key - The key of the feature flag
+  * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<T>}
+  */
   async get(key, defaultValue, options) {
     switch (typeof defaultValue) {
       case "boolean": {
@@ -140,6 +228,14 @@ var Toggle = class extends import_hookified.Hookified {
       }
     }
   }
+  /**
+  * Get a boolean value from the feature flag. This will check the type of the default value and call the
+  * appropriate function. It will also set the context if it is not set.
+  * @param {string} key - The key of the feature flag
+  * @param {boolean} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<boolean>} - The value of the feature flag
+  */
   async getBoolean(key, defaultValue, options) {
     try {
       const data = {
@@ -166,6 +262,13 @@ var Toggle = class extends import_hookified.Hookified {
     }
     return defaultValue;
   }
+  /**
+  * Get a string value from the feature flag.
+  * @param {string} key - The key of the feature flag
+  * @param {string} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<string>} - The value of the feature flag
+  */
   async getString(key, defaultValue, options) {
     try {
       const data = {
@@ -218,6 +321,14 @@ var Toggle = class extends import_hookified.Hookified {
     }
     return defaultValue;
   }
+  /**
+  * Get an object value from the feature flag. This will check the type of the default value and call the
+  * appropriate function. It will also set the context if it is not set.
+  * @param {string} key - The key of the feature flag
+  * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<T>} - The value of the feature flag
+  */
   async getObject(key, defaultValue, options) {
     try {
       const data = {

package/dist/index.d.cts

@@ -19,10 +19,10 @@ type ToggleOptions = {
      */
     applicationId: string;
     /**
-     * Your Hyphen API key
+     * Your Hyphen Public API key
      * @type {string}
      */
-    publicKey: string;
+    publicApiKey: string;
     /**
      * Your environment name such as development, production. Default is what is set at NODE_ENV
      * @type {string}
@@ -56,35 +56,136 @@ type ToggleOptions = {
     uris?: string[];
 };
 type ToggleRequestOptions = {
+    /**
+     * The context to use for evaluating feature flags
+     * @type {ToggleContext}
+     */
     context?: ToggleContext;
 };
 declare class Toggle extends Hookified {
     private _applicationId;
-    private _publicKey;
+    private _publicApiKey;
     private _environment;
     private _client;
     private _context;
     private _throwErrors;
     private _uris?;
     constructor(options: ToggleOptions);
+    /**
+     * Get the application ID
+     * @returns {string}
+     */
     get applicationId(): string;
+    /**
+     * Set the application ID
+     * @param {string} value
+     */
     set applicationId(value: string);
-    get publicKey(): string;
-    set publicKey(value: string);
+    /**
+     * Get the public API key
+     * @returns {string}
+     */
+    get publicApiKey(): string;
+    /**
+     * Set the public API key
+     * @param {string} value
+     */
+    set publicApiKey(value: string);
+    /**
+     * Get the environment
+     * @returns {string}
+     */
     get environment(): string;
+    /**
+     * Set the environment
+     * @param {string} value
+     */
     set environment(value: string);
+    /**
+     * Get the throwErrors. If true, errors will be thrown in addition to being emitted.
+     * @returns {boolean}
+     */
     get throwErrors(): boolean;
+    /**
+     * Set the throwErrors. If true, errors will be thrown in addition to being emitted.
+     * @param {boolean} value
+     */
     set throwErrors(value: boolean);
+    /**
+     * Get the current context. This is the default context used. You can override this at the get function level.
+     * @returns {ToggleContext}
+     */
     get context(): ToggleContext | undefined;
+    /**
+     * Set the context. This is the default context used. You can override this at the get function level.
+     * @param {ToggleContext} value
+     */
     set context(value: ToggleContext | undefined);
+    /**
+     * Get the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+     * @returns {Array<string>}
+     */
     get uris(): string[] | undefined;
+    /**
+     * Set the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+     * @param {Array<string>} value
+     */
     set uris(value: string[] | undefined);
+    /**
+     * This is a helper function to set the public API key. It will check if the key starts with public_ and set it. If it
+     * does set it will also set the client to undefined to force a new one to be created. If it does not,
+     * it will emit an error and console warning and not set the key. Used by the constructor and publicApiKey setter.
+     * @param key
+     * @returns
+     */
+    setPublicApiKey(key: string): void;
+    /**
+     * Set the context. This is the default context used. You can override this at the get function level.
+     * @param {ToggleContext} context
+     */
     setContext(context: ToggleContext): void;
+    /**
+     * Helper function to get the client. This will create a new client if one does not exist. It will also set the
+     * application ID, environment, and URIs if they are not set. This is used by the get function to get the client.
+     * This is normally only used internally.
+     * @returns {Promise<Client>}
+     */
     getClient(): Promise<Client>;
+    /**
+     * This is the main function to get a feature flag value. It will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<T>}
+     */
     get<T>(key: string, defaultValue: T, options?: ToggleRequestOptions): Promise<T>;
+    /**
+     * Get a boolean value from the feature flag. This will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {boolean} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<boolean>} - The value of the feature flag
+     */
     getBoolean(key: string, defaultValue: boolean, options?: ToggleRequestOptions): Promise<boolean>;
+    /**
+     * Get a string value from the feature flag.
+     * @param {string} key - The key of the feature flag
+     * @param {string} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<string>} - The value of the feature flag
+     */
     getString(key: string, defaultValue: string, options?: ToggleRequestOptions): Promise<string>;
     getNumber(key: string, defaultValue: number, options?: ToggleRequestOptions): Promise<number>;
+    /**
+     * Get an object value from the feature flag. This will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<T>} - The value of the feature flag
+     */
     getObject<T>(key: string, defaultValue: T, options?: ToggleRequestOptions): Promise<T>;
 }
 

package/dist/index.d.ts

@@ -19,10 +19,10 @@ type ToggleOptions = {
      */
     applicationId: string;
     /**
-     * Your Hyphen API key
+     * Your Hyphen Public API key
      * @type {string}
      */
-    publicKey: string;
+    publicApiKey: string;
     /**
      * Your environment name such as development, production. Default is what is set at NODE_ENV
      * @type {string}
@@ -56,35 +56,136 @@ type ToggleOptions = {
     uris?: string[];
 };
 type ToggleRequestOptions = {
+    /**
+     * The context to use for evaluating feature flags
+     * @type {ToggleContext}
+     */
     context?: ToggleContext;
 };
 declare class Toggle extends Hookified {
     private _applicationId;
-    private _publicKey;
+    private _publicApiKey;
     private _environment;
     private _client;
     private _context;
     private _throwErrors;
     private _uris?;
     constructor(options: ToggleOptions);
+    /**
+     * Get the application ID
+     * @returns {string}
+     */
     get applicationId(): string;
+    /**
+     * Set the application ID
+     * @param {string} value
+     */
     set applicationId(value: string);
-    get publicKey(): string;
-    set publicKey(value: string);
+    /**
+     * Get the public API key
+     * @returns {string}
+     */
+    get publicApiKey(): string;
+    /**
+     * Set the public API key
+     * @param {string} value
+     */
+    set publicApiKey(value: string);
+    /**
+     * Get the environment
+     * @returns {string}
+     */
     get environment(): string;
+    /**
+     * Set the environment
+     * @param {string} value
+     */
     set environment(value: string);
+    /**
+     * Get the throwErrors. If true, errors will be thrown in addition to being emitted.
+     * @returns {boolean}
+     */
     get throwErrors(): boolean;
+    /**
+     * Set the throwErrors. If true, errors will be thrown in addition to being emitted.
+     * @param {boolean} value
+     */
     set throwErrors(value: boolean);
+    /**
+     * Get the current context. This is the default context used. You can override this at the get function level.
+     * @returns {ToggleContext}
+     */
     get context(): ToggleContext | undefined;
+    /**
+     * Set the context. This is the default context used. You can override this at the get function level.
+     * @param {ToggleContext} value
+     */
     set context(value: ToggleContext | undefined);
+    /**
+     * Get the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+     * @returns {Array<string>}
+     */
     get uris(): string[] | undefined;
+    /**
+     * Set the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+     * @param {Array<string>} value
+     */
     set uris(value: string[] | undefined);
+    /**
+     * This is a helper function to set the public API key. It will check if the key starts with public_ and set it. If it
+     * does set it will also set the client to undefined to force a new one to be created. If it does not,
+     * it will emit an error and console warning and not set the key. Used by the constructor and publicApiKey setter.
+     * @param key
+     * @returns
+     */
+    setPublicApiKey(key: string): void;
+    /**
+     * Set the context. This is the default context used. You can override this at the get function level.
+     * @param {ToggleContext} context
+     */
     setContext(context: ToggleContext): void;
+    /**
+     * Helper function to get the client. This will create a new client if one does not exist. It will also set the
+     * application ID, environment, and URIs if they are not set. This is used by the get function to get the client.
+     * This is normally only used internally.
+     * @returns {Promise<Client>}
+     */
     getClient(): Promise<Client>;
+    /**
+     * This is the main function to get a feature flag value. It will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<T>}
+     */
     get<T>(key: string, defaultValue: T, options?: ToggleRequestOptions): Promise<T>;
+    /**
+     * Get a boolean value from the feature flag. This will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {boolean} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<boolean>} - The value of the feature flag
+     */
     getBoolean(key: string, defaultValue: boolean, options?: ToggleRequestOptions): Promise<boolean>;
+    /**
+     * Get a string value from the feature flag.
+     * @param {string} key - The key of the feature flag
+     * @param {string} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<string>} - The value of the feature flag
+     */
     getString(key: string, defaultValue: string, options?: ToggleRequestOptions): Promise<string>;
     getNumber(key: string, defaultValue: number, options?: ToggleRequestOptions): Promise<number>;
+    /**
+     * Get an object value from the feature flag. This will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<T>} - The value of the feature flag
+     */
     getObject<T>(key: string, defaultValue: T, options?: ToggleRequestOptions): Promise<T>;
 }
 

package/dist/index.js

@@ -2,7 +2,7 @@ var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
 // src/toggle.ts
-import process from "node:process";
+import process from "process";
 import { Hookified } from "hookified";
 import { OpenFeature } from "@openfeature/server-sdk";
 import { HyphenProvider } from "@hyphen/openfeature-server-provider";
@@ -22,61 +22,141 @@ var Toggle = class extends Hookified {
     __name(this, "Toggle");
   }
   _applicationId;
-  _publicKey;
+  _publicApiKey = "";
   _environment;
   _client;
   _context;
   _throwErrors = false;
   _uris;
+  /*
+   * Create a new Toggle instance. This will create a new client and set the options.
+   * @param {ToggleOptions}
+  */
   constructor(options) {
     super();
     this._applicationId = options.applicationId;
-    this._publicKey = options.publicKey;
+    this.setPublicApiKey(options.publicApiKey);
     this._environment = options.environment ?? process.env.NODE_ENV ?? "development";
     this._context = options.context;
     this._throwErrors = options.throwErrors ?? false;
     this._uris = options.uris;
   }
+  /**
+  * Get the application ID
+  * @returns {string}
+  */
   get applicationId() {
     return this._applicationId;
   }
+  /**
+  * Set the application ID
+  * @param {string} value
+  */
   set applicationId(value) {
     this._applicationId = value;
   }
-  get publicKey() {
-    return this._publicKey;
+  /**
+  * Get the public API key
+  * @returns {string}
+  */
+  get publicApiKey() {
+    return this._publicApiKey;
   }
-  set publicKey(value) {
-    this._publicKey = value;
+  /**
+  * Set the public API key
+  * @param {string} value
+  */
+  set publicApiKey(value) {
+    this.setPublicApiKey(value);
   }
+  /**
+  * Get the environment
+  * @returns {string}
+  */
   get environment() {
     return this._environment;
   }
+  /**
+  * Set the environment
+  * @param {string} value
+  */
   set environment(value) {
     this._environment = value;
   }
+  /**
+  * Get the throwErrors. If true, errors will be thrown in addition to being emitted.
+  * @returns {boolean}
+  */
   get throwErrors() {
     return this._throwErrors;
   }
+  /**
+  * Set the throwErrors. If true, errors will be thrown in addition to being emitted.
+  * @param {boolean} value
+  */
   set throwErrors(value) {
     this._throwErrors = value;
   }
+  /**
+  * Get the current context. This is the default context used. You can override this at the get function level.
+  * @returns {ToggleContext}
+  */
   get context() {
     return this._context;
   }
+  /**
+  * Set the context. This is the default context used. You can override this at the get function level.
+  * @param {ToggleContext} value
+  */
   set context(value) {
     this._context = value;
   }
+  /**
+  * Get the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+  * @returns {Array<string>}
+  */
   get uris() {
     return this._uris;
   }
+  /**
+  * Set the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+  * @param {Array<string>} value
+  */
   set uris(value) {
     this._uris = value;
   }
+  /**
+  * This is a helper function to set the public API key. It will check if the key starts with public_ and set it. If it
+  * does set it will also set the client to undefined to force a new one to be created. If it does not, 
+  * it will emit an error and console warning and not set the key. Used by the constructor and publicApiKey setter.
+  * @param key 
+  * @returns 
+  */
+  setPublicApiKey(key) {
+    if (!key.startsWith("public_")) {
+      this.emit("error", new Error("Public API key should start with public_"));
+      if (process.env.NODE_ENV !== "production") {
+        console.error("Public API key should start with public_");
+      }
+      return;
+    }
+    this._publicApiKey = key;
+    this._client = void 0;
+  }
+  /**
+  * Set the context. This is the default context used. You can override this at the get function level.
+  * @param {ToggleContext} context
+  */
   setContext(context) {
     this._context = context;
     this._client = void 0;
   }
+  /**
+  * Helper function to get the client. This will create a new client if one does not exist. It will also set the
+  * application ID, environment, and URIs if they are not set. This is used by the get function to get the client.
+  * This is normally only used internally.
+  * @returns {Promise<Client>}
+  */
   async getClient() {
     if (!this._client) {
       const options = {
@@ -84,11 +164,19 @@ var Toggle = class extends Hookified {
         environment: this._environment,
         horizonUrls: this._uris
       };
-      await OpenFeature.setProviderAndWait(new HyphenProvider(this._publicKey, options));
+      await OpenFeature.setProviderAndWait(new HyphenProvider(this._publicApiKey, options));
       this._client = OpenFeature.getClient(this._context);
     }
     return this._client;
   }
+  /**
+  * This is the main function to get a feature flag value. It will check the type of the default value and call the
+  * appropriate function. It will also set the context if it is not set.
+  * @param {string} key - The key of the feature flag
+  * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<T>}
+  */
   async get(key, defaultValue, options) {
     switch (typeof defaultValue) {
       case "boolean": {
@@ -105,6 +193,14 @@ var Toggle = class extends Hookified {
       }
     }
   }
+  /**
+  * Get a boolean value from the feature flag. This will check the type of the default value and call the
+  * appropriate function. It will also set the context if it is not set.
+  * @param {string} key - The key of the feature flag
+  * @param {boolean} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<boolean>} - The value of the feature flag
+  */
   async getBoolean(key, defaultValue, options) {
     try {
       const data = {
@@ -131,6 +227,13 @@ var Toggle = class extends Hookified {
     }
     return defaultValue;
   }
+  /**
+  * Get a string value from the feature flag.
+  * @param {string} key - The key of the feature flag
+  * @param {string} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<string>} - The value of the feature flag
+  */
   async getString(key, defaultValue, options) {
     try {
       const data = {
@@ -183,6 +286,14 @@ var Toggle = class extends Hookified {
     }
     return defaultValue;
   }
+  /**
+  * Get an object value from the feature flag. This will check the type of the default value and call the
+  * appropriate function. It will also set the context if it is not set.
+  * @param {string} key - The key of the feature flag
+  * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+  * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+  * @returns {Promise<T>} - The value of the feature flag
+  */
   async getObject(key, defaultValue, options) {
     try {
       const data = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",