es-toolkit/dist/compat/function/identity.d.ts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

//#region src/compat/function/identity.d.ts
/**
 * Returns the input value unchanged.
 *
 * @template T - The type of the input value.
 * @param x - The value to be returned.
 * @returns The input value.
 *
 * @example
 * // Returns 5
 * identity(5);
 *
 * @example
 * // Returns 'hello'
 * identity('hello');
 *
 * @example
 * // Returns { key: 'value' }
 * identity({ key: 'value' });
 */
declare function identity<T>(value: T): T;
/**
 * Returns the input value unchanged.
 *
 * @template T - The type of the input value.
 * @param x - The value to be returned.
 * @returns The input value.
 *
 * @example
 * // Returns 5
 * identity(5);
 *
 * @example
 * // Returns 'hello'
 * identity('hello');
 *
 * @example
 * // Returns { key: 'value' }
 * identity({ key: 'value' });
 */
declare function identity(): undefined;
//#endregion
export { identity };