camelcase

  • Version 6.2.0
  • Published
  • 10.4 kB
  • No dependencies
  • MIT license

Install

npm i camelcase
yarn add camelcase
pnpm add camelcase

Overview

Convert a dash/dot/underscore/space separated string to camelCase or PascalCase: `foo-bar` → `fooBar`

Index

Functions

function camelcase

camelcase: (
input: string | readonly string[],
options?: camelcase.Options
) => string;
  • Convert a dash/dot/underscore/space separated string to camelCase or PascalCase: foo-barfooBar.

    Correctly handles Unicode strings.

    Parameter input

    String to convert to camel case.

    Example 1

    import camelCase = require('camelcase');
    camelCase('foo-bar');
    //=> 'fooBar'
    camelCase('foo_bar');
    //=> 'fooBar'
    camelCase('Foo-Bar');
    //=> 'fooBar'
    camelCase('розовый_пушистый_единороги');
    //=> 'розовыйПушистыйЕдинороги'
    camelCase('Foo-Bar', {pascalCase: true});
    //=> 'FooBar'
    camelCase('--foo.bar', {pascalCase: false});
    //=> 'fooBar'
    camelCase('Foo-BAR', {preserveConsecutiveUppercase: true});
    //=> 'fooBAR'
    camelCase('fooBAR', {pascalCase: true, preserveConsecutiveUppercase: true}));
    //=> 'FooBAR'
    camelCase('foo bar');
    //=> 'fooBar'
    console.log(process.argv[3]);
    //=> '--foo-bar'
    camelCase(process.argv[3]);
    //=> 'fooBar'
    camelCase(['foo', 'bar']);
    //=> 'fooBar'
    camelCase(['__foo__', '--bar'], {pascalCase: true});
    //=> 'FooBar'
    camelCase(['foo', 'BAR'], {pascalCase: true, preserveConsecutiveUppercase: true})
    //=> 'FooBAR'
    camelCase('lorem-ipsum', {locale: 'en-US'});
    //=> 'loremIpsum'

Interfaces

interface Options

interface Options {}

    property locale

    readonly locale?: string | readonly string[];
    • The locale parameter indicates the locale to be used to convert to upper/lower case according to any locale-specific case mappings. If multiple locales are given in an array, the best available locale is used.

      Default: The host environment’s current locale.

      Example 1

      ``` import camelCase = require('camelcase');

      camelCase('lorem-ipsum', {locale: 'en-US'}); //=> 'loremIpsum' camelCase('lorem-ipsum', {locale: 'tr-TR'}); //=> 'loremİpsum' camelCase('lorem-ipsum', {locale: ['en-US', 'en-GB']}); //=> 'loremIpsum' camelCase('lorem-ipsum', {locale: ['tr', 'TR', 'tr-TR']}); //=> 'loremİpsum' ```

    property pascalCase

    readonly pascalCase?: boolean;
    • Uppercase the first character: foo-barFooBar.

      false

    property preserveConsecutiveUppercase

    readonly preserveConsecutiveUppercase?: boolean;
    • Preserve the consecutive uppercase characters: foo-BARFooBAR.

      false

    Package Files (1)

    Dependencies (0)

    No dependencies.

    Dev Dependencies (3)

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/camelcase.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/camelcase)
    • HTML
      <a href="https://www.jsdocs.io/package/camelcase"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>