Convert between type-safe string casings.
---
## About
A zero-dependency package for converting between string casings in a type-safe way.
### Supported Casings
| Name |
| -------------------- |
| camelCase |
| PascalCase |
| kebab-case |
| snake_case |
| Train-Case |
| CONSTANT_CASE |
| Title Case |
| UPPER CASE |
| lower case |
## Installation
```sh
npm install typed-case
```
```sh
yarn add typed-case
```
```sh
pnpm add typed-case
```
```sh
bun add typed-case
```
## Contents
- [Usage](#usage)
- [CamelCase](#camelcase)
- [PascalCase](#pascalcase)
- [TrainCase](#traincase)
- [KebabCase](#kebabcase)
- [SnakeCase](#snakecase)
- [ConstantCase](#constantcase)
- [Title Case](#title-case)
- [UpperCase, LowerCase](#uppercase-lowercase)
- [Capitalize, Uncapitalize](#capitalize-uncapitalize)
- [License](#license)
## Usage
### CamelCase
```ts
import { toCamelCase, CamelCase } from "typed-case";
toCamelCase("hello world"); // "helloWorld"
toCamelCase("hello_world"); // "helloWorld"
toCamelCase("hello-world"); // "helloWorld"
```
#### Preserve UpperCase
```ts
toCamelCase("hello WORLD"); // "helloWORLD"
toCamelCase("hello WORLD", { preserveConsecutiveUppercase: false }); // "helloWorld"
```
### PascalCase
```ts
import { toPascalCase, PascalCase } from "typed-case";
toPascalCase("hello world"); // "HelloWorld"
toPascalCase("hello_world"); // "HelloWorld"
toPascalCase("hello-world"); // "HelloWorld"
```
#### Preserve UpperCase
```ts
toPascalCase("hello WORLD"); // "HelloWORLD"
toPascalCase("hello WORLD", { preserveConsecutiveUppercase: false }); // "HelloWorld"
```
### TrainCase
```ts
import { toTrainCase, TrainCase } from "typed-case";
toTrainCase("hello world"); // "Hello-World"
toTrainCase("hello_world"); // "Hello-World"
toTrainCase("hello-world"); // "Hello-World"
```
### TitleCase
```ts
import { toTitleCase, TitleCase } from "typed-case";
toTitleCase("hello world"); // "Hello World"
toTitleCase("hello_world"); // "Hello World"
toTitleCase("hello-world"); // "Hello World"
```
#### Preserve UpperCase
```ts
toTitleCase("hello WORLD"); // "Hello WORLD"
toTitleCase("hello WORLD", { preserveConsecutiveUppercase: false }); // "Hello World"
```
### KebabCase
```ts
import { toKebabCase, KebabCase } from "typed-case";
toKebabCase("hello world"); // "hello-world"
toKebabCase("hello_world"); // "hello-world"
toKebabCase("hello-world"); // "hello-world"
```
### SnakeCase
```ts
import { toSnakeCase, SnakeCase } from "typed-case";
toSnakeCase("hello world"); // "hello_world"
toSnakeCase("hello_world"); // "hello_world"
toSnakeCase("hello-world"); // "hello_world"
```
### ConstantCase
```ts
import { toConstantCase, ConstantCase } from "typed-case";
toConstantCase("hello world"); // "HELLO_WORLD"
toConstantCase("hello_world"); // "HELLO_WORLD"
toConstantCase("hello-world"); // "HELLO_WORLD"
```
### UpperCase, LowerCase
```ts
import { toUpperCase, toLowerCase, UpperCase, LowerCase } from "typed-case";
toUpperCase("hello world"); // "HELLO WORLD"
toLowerCase("HELLO WORLD"); // "hello world"
```
### Capitalize, Uncapitalize
```ts
import { capitalize, uncapitalize } from "typed-case";
capitalize("hello world"); // "Hello world"
uncapitalize("Hello world"); // "hello world"
```
License 
[MIT](https://opensource.org/licenses/MIT) - _MIT License_
