case-converters
Version:
Change case functions for all cases in TypeScript and JavaScript. Combined version of all [`case-converters`](https://github.com/cvchauhan/case-converter) methods, so you do not need to install them separately. ESM and CJS bundles are included, also bac
166 lines (140 loc) • 4.73 kB
Markdown
# case-converters
Change case functions for all cases in TypeScript and JavaScript.
Combined version of all [`case-converters`](https://github.com/cvchauhan/case-converter) methods, so you do not need to install them separately.
ESM and CJS bundles are included, also backwards compatible with case-converters@3.0.1.
`case-converters@4.0.0` which can be used to access all methods.
Added Object convertore for camel, constan and capital
you can use this 3 methods to convert object key in case:
objToCamel(obj or array)
objToConstant(obj or array)
objToCapital(obj or array)
## Usage
```shell script
npm install --save case-converters
```
#### javascript
```javascript
const { camel, upper } from 'case-converters';
camel('test string'); // testString
upper('test string'); // TEST STRING
```
### Browser / ESM
```ts
import { Case } from 'case-converters';
const camel = Case.camel('test string'); // testString
const upper = Case.upper('test string'); // TEST STRING
const input = [
{ 'user_name': 'Alice' },
{ 'user_name': 'Bob' }
]
Case.objToCamel(input)
const {
objToCamel,
objToCapital,
objToConstant,
objToNot,
objToPascal,
objToPath,
objToSentence,
objToSnake,
objToTrain,
objToKebap,
objToSponge,
objToSwap,
objToTitle,
objToUpper,
objToLower
} = require('case-converters');
objToCamel(input)
/*
[
{ userName: 'Alice' },
{ userName: 'Bob' }
]
*/
objToCapital(input)
/*
[
{ Username: 'Alice' },
{ Username: 'Bob' }
]
*/
objToConstant(input)
/*
[
{ USERNAME: 'Alice' },
{ USERNAME: 'Bob' }
]
*/
import { camel, upper, ... } from 'case-converters';
const camel = camel('test string'); // testString
const upper = upper('test string'); // TEST STRING
```
### Node.js
```ts
const { Case } = require("case-converters");
const camel = Case.camel("foo-bar"); // fooBar
const snake = Case.snake("fooBar"); // foo_bar
const { camel, snake } = require("case-converters");
const camel = camel("foo-bar"); // fooBar
const snake = snake("fooBar"); // foo_bar
```
## Links
- **Original project:** https://github.com/cvchauhan/case-converter
## Methods
### Class based usage
```ts
import { Case } from "case-converters";
const str = "test string";
camel = Case.camel(str); // testString
capital = Case.capital(str); // Test String
constant = Case.constant(str); // TEST_STRING
dot = Case.dot(str); // test.string
no = Case.no(str); // test string
pascal = Case.pascal(str); // TestString
path = Case.path(str); // test/string
sentence = Case.sentence(str); // Test string
snake = Case.snake(str); // test_string
train = Case.train(str); // Test-String
kebab = Case.kebab(str); // test-string
sponge = Case.sponge(str); // TeSt StRiNg
swapCase = Case.swap(str); // TEST STRING
title = Case.title(str); // Test String
uppper = Case.upper(str); // TEST STRING
localeUpper = Case.localeUpper(str, "en"); // TEST STRING
lower = Case.lower(str); // test string
localeLower = Case.localeLower(str, "en"); // test string
lowerFirst = Case.lowerFirst(str); // test string
upperFirst = Case.upperFirst(str); // Test string
isUpper = Case.isUpper(str); // false
isLower = Case.isLower(str); // true
```
### Function based usage
```ts
import { camel, upper, ... } from 'case-converters';
const str = 'test string';
camel = camel(str); // testString
capital = capital(str); // Test String
constant = constant(str); // TEST_STRING
dot = dot(str); // test.string
no = no(str); // test string
pascal = pascal(str); // TestString
path = path(str); // test/string
sentence = sentence(str); // Test string
snake = snake(str); // test_string
train = train(str); // Test-String
kebab = kebab(str); // test-string
sponge = sponge(str); // TeSt StRiNg
swap = swap(str); // TEST STRING
title = title(str); // Test String
uppper = upper(str); // TEST STRING
localeUpper = localeUpper(str, 'en'); // TEST STRING
lower = lower(str); // test string
localeLower = localeLower(str, 'en'); // test string
lowerFirst = lowerFirst(str); // test string
upperFirst = upperFirst(str); // Test string
isUpper = isUpper(str); // false
isLower = isLower(str); // true
```
## Meta
- chiragvchauhan93@gmail.com