Ninjas Practicing Multidimensionality

    @stdlib/string-camelcase
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.4 • Public • Published

    camelcase

    NPM version Build Status Coverage Status

    Convert a string to camel case.

    Installation

    npm install @stdlib/string-camelcase

    Usage

    var camelcase = require( '@stdlib/string-camelcase' );

    camelcase( str )

    Converts a string to camel case.

    var out = camelcase( 'foo bar' );
    // returns 'fooBar'
    
    out = camelcase( 'IS_MOBILE' );
    // returns 'isMobile'
    
    out = camelcase( 'Hello World!' );
    // returns 'helloWorld'
    
    out = camelcase( '--foo-bar--' );
    // returns 'fooBar'

    Examples

    var camelcase = require( '@stdlib/string-camelcase' );
    
    var str = 'Hello World!';
    var out = camelcase( str );
    // returns 'helloWorld'
    
    str = 'HELLO WORLD!';
    out = camelcase( str );
    // returns 'helloWorld'
    
    str = 'To be, or not to be: that is the question.';
    out = camelcase( str );
    // returns 'toBeOrNotToBeThatIsTheQuestion'

    CLI

    Installation

    To use the module as a general utility, install the module globally

    npm install -g @stdlib/string-camelcase

    Usage

    Usage: camelcase [options] [<string>]
    
    Options:
    
      -h,    --help                Print this message.
      -V,    --version             Print the package version.
             --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
    

    Notes

    • If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

      # Not escaped...
      $ echo -n $'beep\nfoo_bar' | camelcase --split /\r?\n/
      
      # Escaped...
      $ echo -n $'beep\nfoo_bar' | camelcase --split /\\r?\\n/
    • The implementation ignores trailing delimiters.

    Examples

    $ camelcase 'hello world!'
    helloWorld

    To use as a standard stream,

    $ echo -n 'beEp booP' | camelcase
    beEpBooP

    By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

    $ echo -n 'beep\nfoo_bar' | camelcase --split '\t'
    beep
    fooBar

    See Also


    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/string-camelcase

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    41

    Version

    0.0.4

    License

    Apache-2.0

    Unpacked Size

    29.2 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser