@ayonli/jsext/types/wrap.d.ts

A JavaScript extension package for building strong and modern applications.

/**
 * Wraps a function for decorator pattern but keep its signature.
 * @module
 */
/**
 * Wraps a function inside another function and returns a new function that
 * copies the original function's name and other properties.
 *
 * @example
 * ```ts
 * import wrap from "@ayonli/jsext/wrap";
 *
 * function log(text: string) {
 *     console.log(text);
 * }
 *
 * const show = wrap(log, function (fn, text) {
 *     return fn.call(this, new Date().toISOString() + " " + text);
 * });
 *
 * console.log(show.name); // log
 * console.log(show.length); // 1
 * console.assert(show.toString() === log.toString());
 * ```
 */
export default function wrap<T, Fn extends (this: T, ...args: any[]) => any>(fn: Fn, wrapper: (this: T, fn: Fn, ...args: Parameters<Fn>) => ReturnType<Fn>): Fn;