kasi
Version:
A collection of functions for working with different casings.
259 lines (171 loc) • 5.41 kB
Markdown
A collection of functions for working with different casings.
```sh
npm install kasi
```
| Check | Convert | Extra |
| --------------------------------- | --------------------------------- | ----------------- |
| [isCamelCase](
| [isConstantCase](
| [isDotCase](
| [isKebabCase](
| [isLowerCase](
| [isPascalCase](
| [isPathCase](
| [isSnakeCase](
| [isTitleCase](
| [isUpperCase](
These functions allow you to check if a string is using a specific casing.
```ts
import {isCamelCase} from 'kasi';
isCamelCase ( 'fooBar' ); // => true
isCamelCase ( 'foo-bar' ); // => false
```
```ts
import {isConstantCase} from 'kasi';
isConstantCase ( 'FOO_BAR' ); // => true
isConstantCase ( 'fooBar' ); // => false
```
```ts
import {isDotCase} from 'kasi';
isDotCase ( 'foo.bar' ); // => true
isDotCase ( 'fooBar' ); // => false
```
```ts
import {isKebabCase} from 'kasi';
isKebabCase ( 'foo-bar' ); // => true
isKebabCase ( 'fooBar' ); // => false
```
```ts
import {isLowerCase} from 'kasi';
isLowerCase ( 'foo' ); // => true
isLowerCase ( 'Foo' ); // => false
```
```ts
import {isPascalCase} from 'kasi';
isPascalCase ( 'FooBar' ); // => true
isPascalCase ( 'fooBar' ); // => false
```
```ts
import {isPathCase} from 'kasi';
isPathCase ( 'foo/bar' ); // => true
isPathCase ( 'fooBar' ); // => false
```
```ts
import {isSnakeCase} from 'kasi';
isSnakeCase ( 'foo_bar' ); // => true
isSnakeCase ( 'fooBar' ); // => false
```
```ts
import {isTitleCase} from 'kasi';
isTitleCase ( 'Foo Bar' ); // => true
isTitleCase ( 'fooBar' ); // => false
```
```ts
import {isUpperCase} from 'kasi';
isUpperCase ( 'FOO' ); // => true
isUpperCase ( 'foo' ); // => false
```
These functions allow you to convert a string to a specific casing.
```ts
import {toCamelCase} from 'kasi';
toCamelCase ( 'foo-bar' ); // => 'fooBar'
toCamelCase ( 'foo_bar' ); // => 'fooBar'
```
```ts
import {toConstantCase} from 'kasi';
toConstantCase ( 'fooBar' ); // => 'FOO_BAR'
toConstantCase ( 'foo-bar' ); // => 'FOO_BAR'
```
```ts
import {toDotCase} from 'kasi';
toDotCase ( 'fooBar' ); // => 'foo.bar'
toDotCase ( 'foo-bar' ); // => 'foo.bar'
```
```ts
import {toKebabCase} from 'kasi';
toKebabCase ( 'fooBar' ); // => 'foo-bar'
toKebabCase ( 'foo_bar' ); // => 'foo-bar'
```
```ts
import {toLowerCase} from 'kasi';
toLowerCase ( 'FooBar' ); // => 'foobar'
toLowerCase ( 'foo-bar' ); // => 'foo-bar'
```
```ts
import {toPascalCase} from 'kasi';
toPascalCase ( 'foo-bar' ); // => 'FooBar'
toPascalCase ( 'foo_bar' ); // => 'FooBar'
```
```ts
import {toPathCase} from 'kasi';
toPathCase ( 'fooBar' ); // => 'foo/bar'
toPathCase ( 'foo-bar' ); // => 'foo/bar'
```
```ts
import {toSnakeCase} from 'kasi';
toSnakeCase ( 'fooBar' ); // => 'foo_bar'
toSnakeCase ( 'foo-bar' ); // => 'foo_bar'
```
```ts
import {toTitleCase} from 'kasi';
toTitleCase ( 'fooBar' ); // => 'Foo Bar'
toTitleCase ( 'foo-bar' ); // => 'Foo Bar'
```
```ts
import {toUpperCase} from 'kasi';
toUpperCase ( 'fooBar' ); // => 'FOOBAR'
toUpperCase ( 'foo-bar' ); // => 'FOO-BAR'
```
These extra functions perform other operations related to casings.
Transform a string to the given casing. Useful in combination with `detect`.
```ts
import {apply} from 'kasi';
apply ( 'foo-bar', 'camel' ); // => 'fooBar'
apply ( 'foo-bar', 'constant' ); // => 'FOO_BAR'
```
This function copies the casing of a string to another string, character by character. The two strings must have the same length.
```ts
import {copy} from 'kasi';
copy ( 'sIlLy', 'lions' ); // => 'lIoNs'
copy ( 'SiLlY', 'lions' ); // => 'LiOnS'
```
This function detects the casing of a string. Useful in combination with `apply`.
```ts
import {detect} from 'kasi';
detect ( 'fooBar' ); // => 'camel'
detect ( 'FOO_BAR' ); // => 'constant'
detect ( ' foo BAR ' ); // => 'unknown'
```
- **[Kasi for VSCode](https://marketplace.visualstudio.com/items?itemName=fabiospampinato.kasi)**: The official companion extension for Kasi, for quickly changing the casing of your selections.
MIT © Fabio Spampinato