mirror of
https://github.com/toss/es-toolkit.git
synced 2024-12-03 01:42:44 +03:00
16d326c4b2
* feat(capitalize): add capitalize * fix(capitalize): return type * Update docs/ko/reference/string/capitalize.md --------- Co-authored-by: Sojin Park <raon0211@gmail.com>
27 lines
485 B
Markdown
27 lines
485 B
Markdown
# capitalize
|
|
|
|
Converts the first character of string to upper case and the remaining to lower case.
|
|
|
|
## Signature
|
|
|
|
```typescript
|
|
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
|
|
|
|
```typescript
|
|
import { capitalize } from 'es-toolkit/string';
|
|
|
|
capitalize('fred'); // returns 'Fred'
|
|
capitalize('FRED'); // returns 'Fred'
|
|
```
|