mirror of https://github.com/toss/es-toolkit.git synced 2024-11-24 03:32:58 +03:00

feat(capitalize): add capitalize (#161 )

* feat(capitalize): add capitalize

* fix(capitalize): return type

* Update docs/ko/reference/string/capitalize.md

---------

Co-authored-by: Sojin Park <raon0211@gmail.com>

2024-07-12 10:07:40 +09:00

485 B

Raw Blame History

capitalize

Converts the first character of string to upper case and the remaining to lower case.

Signature

function capitalize<T extends string>(str: T): Capitalize<T>;

Parameters

str (T): The string to be converted to uppercase.

Returns

(Capitalize<string>): The capitalized string.

Examples

import { capitalize } from 'es-toolkit/string';

capitalize('fred'); // returns 'Fred'
capitalize('FRED'); // returns 'Fred'

485 B Raw Blame History