pascalcase
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/pascalcase package

    2.0.0 • Public • Published

    pascalcase NPM version NPM monthly downloads NPM total downloads Tests

    Convert a string to pascal case (upper camelcase).

    Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

    Install

    Install with npm (requires Node.js >=14):

    $ npm install --save pascalcase

    Prerequisites

    Requires Node.js version >= 14.

    Usage

    import pascalcase from 'pascalcase';
    // or the following if you prefer
    import { pascalcase } from 'pascalcase';
    
    console.log(pascalcase('a')); //=> 'A'
    console.log(pascalcase('foo bar baz')); //=> 'FooBarBaz'
    console.log(pascalcase('  foo bar baz  ')); //=> 'FooBarBaz'
    console.log(pascalcase('foo_bar-baz')); //=> 'FooBarBaz'
    console.log(pascalcase('foo.bar.baz')); //=> 'FooBarBaz'
    console.log(pascalcase('foo/bar/baz')); //=> 'FooBarBaz'
    console.log(pascalcase('foo[bar)baz')); //=> 'FooBarBaz'
    console.log(pascalcase('#foo+bar*baz')); //=> 'FooBarBaz'
    console.log(pascalcase('$foo~bar`baz')); //=> 'FooBarBaz'
    console.log(pascalcase('_foo_bar-baz-')); //=> 'FooBarBaz'
    console.log(pascalcase('foo 2 bar 5 baz')); //=> 'Foo2Bar5Baz'
    console.log(pascalcase('foo2bar5baz')); //=> 'Foo2bar5baz'

    Uppercase character sequences

    If you wish to preserve upper case character sequences, you may pass an options object with the preserveConsecutiveUppercase option set to true:

    console.log(pascalcase('The IRS Is Mean')); //=> 'TheIrsIsMean
    console.log(pascalcase('The IRS Is Mean', { preserveConsecutiveUppercase: true })); //=> TheIRSIsMean
    
    console.log(pascalcase('We saw a UFO')); //=> WeSawAUfo
    console.log(pascalcase('We saw a UFO', { preserveConsecutiveUppercase: true })); //=> WeSawAUFO

    Options

    All options are passed to sindresorhus/camelcase, please visit that project to learn about all available options.

    About

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Running Tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test
    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Related projects

    You might also be interested in these projects:

    • ansi-colors: Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in… more | homepage
    • justified: Wraps words to a specified length and justifies the text in each line. | homepage
    • randomatic: Generate randomized strings of a specified length using simple character sequences. The original generate-password. | homepage
    • word-wrap: Wrap words to a specified length. | homepage

    Author

    Jon Schlinkert

    License

    Copyright © 2021, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.8.0, on December 29, 2021.

    Install

    npm i pascalcase

    DownloadsWeekly Downloads

    16,962,350

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    8.29 kB

    Total Files

    4

    Last publish

    Collaborators

    • jonschlinkert