the-forest/client/node_modules/pascal-case/README.md
2024-09-17 20:35:18 -04:00

48 lines
1.3 KiB
Markdown

# Pascal Case
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![Bundle size][bundlephobia-image]][bundlephobia-url]
> Transform into a string of capitalized words without separators.
## Installation
```
npm install pascal-case --save
```
## Usage
```js
import { pascalCase } from "pascal-case";
pascalCase("string"); //=> "String"
pascalCase("dot.case"); //=> "DotCase"
pascalCase("PascalCase"); //=> "PascalCase"
pascalCase("version 1.2.10"); //=> "Version_1_2_10"
```
The function also accepts [`options`](https://github.com/blakeembrey/change-case#options).
### Merge Numbers
If you'd like to remove the behavior prefixing `_` before numbers, you can use `pascalCaseTransformMerge`:
```js
import { pascalCaseTransformMerge } from "pascal-case";
pascalCase("version 12", { transform: pascalCaseTransformMerge }); //=> "Version12"
```
## License
MIT
[npm-image]: https://img.shields.io/npm/v/pascal-case.svg?style=flat
[npm-url]: https://npmjs.org/package/pascal-case
[downloads-image]: https://img.shields.io/npm/dm/pascal-case.svg?style=flat
[downloads-url]: https://npmjs.org/package/pascal-case
[bundlephobia-image]: https://img.shields.io/bundlephobia/minzip/pascal-case.svg
[bundlephobia-url]: https://bundlephobia.com/result?p=pascal-case