Koadz Platform Binder

The Binder class implements the KoadzBinder interface, providing a singleton pattern implementation to manage and invoke functions dynamically by name. It is designed to store functions in a map and allows adding, retrieving, and executing these functions.

📦 Installation

# Install package globally
npm install -g @koadz/binder@lastest
Copy

Features

• Singleton Instance: Ensures that only one instance of Binder can exist.
• Function Management: Add, retrieve, and execute functions by name.
• Error Handling: Prevents duplicate function names and handles non-existent function calls.

Usage

Getting the Instance of the Binder class:

import {
  Binder, // Singleton instance
  BinderClass, // Class
} from "@koadz/binder";

const binderRef = new Binder(); // Custom instance
Copy

Adding Functions to the Binder instance:

// Adding a single function
Binder.append("sum", (a: number, b: number) => a + b);

// Adding multiple functions
Binder.append({
  subtract: (a: number, b: number) => a - b,
  multiply: (a: number, b: number) => a * b,
});
Copy

Retrieving and Calling Functions:

const sumFunction = Binder.get("sum");
const result = sumFunction(5, 3); // result will be 8

// Directly calling a function
const result = Binder.call("multiply", 5, 3); // result will be 15
Copy

Listing Function names:

console.log(Binder.list()); // ["sum", "subtract", "multiply"]
Copy

Piping multiple Function names:

const initialData = {
  users: [],
  // other properties
};

binder.pipe(["getUser", "cacheUserData"], initialData);
Copy

Overriding Existing Functions:

// Overriding the "sum" function with a new implementation
Binder.override("sum", (a: number, b: number) => a * b);

// Now calling "sum" will use the new implementation
const result = Binder.call("sum", 5, 3); // result will be 15
Copy

Error Handling

• Throws an error if trying to add a function with a name that already exists.
• Throws an error if trying to retrieve or call a non-existent function.