@imhonglu/toolkit v1.0.4

@imhonglu/toolkit

English | 한국어

Introduction

A utility library containing frequently used functions and types with the following features:

• Can be used independently without unnecessary dependencies
• Provides utilities across various categories including arrays, objects, functions, and types
• Strong type inference support based on TypeScript
• All utilities come with detailed documentation and examples

Table of Contents

• Installation
• Usage
• API Reference

Installation

npm install @imhonglu/toolkit

Usage

Let's look at the basic usage of the utility type Fn.Callable.

For more detailed examples, please refer to the API Reference.

import type { Fn } from '@imhonglu/toolkit';

// Provides a type alias for the function type '(...args: any[]) => any'
Fn.Callable // (...args: any[]) => any

// Can define argument types only through generics
Fn.Callable<{ args: [number, number] }> // (...args: [number, number]) => any

// Can define return type only through generics
Fn.Callable<{ return: string }> // (...args: any[]) => string

// Can define both argument and return types through generics
Fn.Callable<{ args: [number, number], return: string }> // (...args: [number, number]) => string

API Reference

Array Utilities

• combinations - Generates all possible combinations from a given array
• chunk - Splits a large array into smaller arrays of specified size

Object Utilities

• clone-prototype - Clones an object including its prototype chain
• invert - Swaps the keys and values of an object
• pick - Creates a new object with selected properties from an object
• omit - Creates a new object excluding specified properties from an object

Function Utilities

• memoize - Caches function results to prevent recalculation for identical inputs
• get-callsites - Retrieves call stack information of currently executing code
• create-safe-executor - Creates a safe function executor with exception handling
• is-async-function - Checks if a given function is asynchronous
• unwrap - Unwraps an Optional value and returns the actual value
• unwrap-or - Returns a default value if the Optional value is empty

Type Utilities

• literal-union - Creates a string literal union type
• array-element - Extracts the element type of an array
• fn - Provides function type utilities
• or - Provides union type utilities
• primitive - Provides primitive type utilities
• mutable - Converts readonly types to mutable types
• nullish-value - Provides Nullish type including null and undefined

String Utilities

• string-case - Provides string case conversion and case style transformation functionality