es-toolkit/dist/compat/string/toLower.d.ts

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

/**
 * Converts the given value to a string and transforms it to lower case.
 * The function can handle various input types by first converting them to strings.
 *
 * @param {unknown} [value=''] The value to convert.
 * @returns {string} Returns the lower cased string.
 * @example
 *
 * toLower('--FOO-BAR--');
 * // => '--foo-bar--'
 *
 * toLower(null);
 * // => ''
 *
 * toLower([1, 2, 3]);
 * // => '1,2,3'
 */
declare function toLower<T extends string = string>(value?: T): Lowercase<T>;

export { toLower };