es-toolkit/docs/reference/string/lowerCase.md
Bert Verhelst b1cb93355a
feat(lowerCase): Add lowerCase function (#166)
* feat(lowerCase): Add lowerCase function

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

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

* Update docs/reference/string/lowerCase.md

Co-authored-by: Evan Moon <bboydart91@gmail.com>

---------

Co-authored-by: Sojin Park <raon0211@gmail.com>
Co-authored-by: Evan Moon <bboydart91@gmail.com>
Co-authored-by: Sojin Park <raon0211@toss.im>
2024-07-12 10:17:34 +09:00

31 lines
704 B
Markdown

# lowerCase
Converts a string to lower case.
Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character. For example, `lower case`.
## Signature
```typescript
function lowerCase(str: string): string;
```
### Parameters
- `str` (`string`): The string that is to be changed to lower case.
### Returns
(`string`) The converted string to lower case.
## Examples
```typescript
import { lowerCase } from 'es-toolkit/string';
lowerCase('camelCase'); // returns 'camel case'
lowerCase('some whitespace'); // returns 'some whitespace'
lowerCase('hyphen-text'); // returns 'hyphen text'
lowerCase('HTTPRequest'); // returns 'http request'
```