chore: add export loadHelpers function

Author: Ma11hewThomas

README.md

@@ -12,9 +12,11 @@ npm install handlebars-helpers-ctrf
 
 ```javascript
 import Handlebars from 'handlebars'
-import { registry } from 'handlebars-helpers-ctrf';
+import { loadHelpers } from 'handlebars-helpers-ctrf';
+
 // Register all helpers with Handlebars
-registry.loadHandlebars(Handlebars);
+loadHelpers(Handlebars);
+
 
 // Now you can use the helpers in your templates
 const template = Handlebars.compile('{{append "test" ".html"}}');

package-lock.json

@@ -1,7 +1,7 @@
 {
 	"name": "handlebars-helpers-ctrf",
-	"version": "0.0.4-next.7",
-	"description": "",
+	"version": "0.0.4-next.8",
+	"description": "A collection of Handlebars helpers for working with Common Test Report Format",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -31,10 +31,7 @@
 		"types/",
 		"README.md"
 	],
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/ctrf-io/handlebars-helpers-ctrf"
-	},
+	"repository": "github:ctrf-io/handlebars-helpers-ctrf",
 	"homepage": "https://ctrf.io",
 	"author": "Matthew Thomas",
 	"license": "MIT",

package.json

@@ -8,6 +8,8 @@ export interface HandlebarsInstance {
 	helpers: Record<string, unknown>;
 }
 
+export type Handlebars = HandlebarsInstance;
+
 /**
  * Describes a filter for selecting helpers by name or category.
  */
@@ -93,7 +95,25 @@ export class HelperRegistry {
 	 * Loads all registered helpers into a Handlebars instance.
 	 * @param handlebars - The Handlebars instance.
 	 */
-	public loadHandlebars(handlebars: HandlebarsInstance) {
+	public loadHandlebars(
+		handlebars:
+			| HandlebarsInstance
+			| {
+					registerHelper: (
+						name: string,
+						fn: (...args: unknown[]) => unknown,
+					) => void;
+			  },
+	) {
+		// Type guard to ensure handlebars has the required methods
+		if (typeof handlebars !== "object" || handlebars === null) {
+			throw new Error("Handlebars instance must be an object");
+		}
+
+		if (typeof handlebars.registerHelper !== "function") {
+			throw new Error("Handlebars instance must have a registerHelper method");
+		}
+
 		for (const helper of this._helpers) {
 			handlebars.registerHelper(helper.name, helper.fn);
 		}

src/helper-registry.ts

@@ -43,6 +43,16 @@ registry.registerHelpers([
 
 registry.loadHandlebars(Handlebars);
 
+/**
+ * load helpers into Handlebars instance.
+ * @param handlebarsInstance - The Handlebars instance to load helpers into
+ */
+export function loadHelpers(handlebarsInstance: {
+	registerHelper: (name: string, fn: (...args: unknown[]) => unknown) => void;
+}) {
+	registry.loadHandlebars(handlebarsInstance);
+}
+
 /**
  * Exports the default helper registry and the HelperRegistry class.
  */