A utility for enhancing functions by binding default values to their first parameter. It's perfect for simplifying APIs, reducing boilerplate code, and ensuring consistent configurations across function calls.
- Default Binding: Bind default values to the first parameter of a function.
- Option Merging: Automatically merge user-provided options with defaults using
Object.assign. - Function Identity: Preserves the original function's name for better debugging.
- Context preservation through proper
thishandling - TypeScript-Friendly: Built with TypeScript in mind, providing full type inference and safety.
- Lightweight: Zero dependencies and minimal overhead.
npm install bind-defaults
# or
yarn add bind-defaultsoriginalFunction: The function to which defaults will be bound.defaults: An object containing default values for the first parameter oforiginalFunction.- Returns: A new function with the defaults bound to its first parameter.
import { bindDefaults } from 'bind-defaults';
// Example function
function createUser(options: {
name: string;
age?: number;
isAdmin?: boolean;
}) {
console.log('Creating user with options:', options);
}
// Bind defaults
const createUserWithDefaults = bindDefaults(createUser, {
age: 25,
isAdmin: false,
});
// Call the bound function
createUserWithDefaults({ name: 'Alice' });
// Output: Creating user with options: { name: 'Alice', age: 25, isAdmin: false }- https://github.com/sgtlambda/merge-bind
- https://github.com/balderdashy/merge-context
MIT License (c) 2025