Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/string-camelcase

Convert a string to camel case.
https://github.com/stdlib-js/string-camelcase

camel camelcase case convert javascript node node-js nodejs snakecase stdlib str string util utilities utility utils

Last synced: about 1 month ago
JSON representation

Convert a string to camel case.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# camelcase



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Convert a string to camel case.



## Installation



```bash

npm install @stdlib/string-camelcase

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

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

```



#### camelcase( str )



Converts a string to camel case.



```javascript

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



```javascript

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 as a general utility, install the CLI package globally



```bash

npm install -g @stdlib/string-camelcase-cli

```



### Usage



```text

Usage: camelcase [options] []



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][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.



    ```bash

    # 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



```bash

$ camelcase 'hello world!'

helloWorld

```



To use as a [standard stream][standard-streams],



```bash

$ echo -n 'beEp booP' | camelcase

beEpBooP

```



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



```bash

$ echo -n 'beep\tfoo_bar' | camelcase --split '\t'

beep

fooBar

```



* * *



## See Also



-   [`@stdlib/string-constantcase`][@stdlib/string/constantcase]: convert a string to constant case.

-   [`@stdlib/string-kebabcase`][@stdlib/string/kebabcase]: convert a string to kebab case.

-   [`@stdlib/string-pascalcase`][@stdlib/string/pascalcase]: convert a string to Pascal case.

-   [`@stdlib/string-snakecase`][@stdlib/string/snakecase]: convert a string to snake case.



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/string-camelcase.svg

[npm-url]: https://npmjs.org/package/@stdlib/string-camelcase



[test-image]: https://github.com/stdlib-js/string-camelcase/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/string-camelcase/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-camelcase/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/string-camelcase?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[cli-section]: https://github.com/stdlib-js/string-camelcase#cli

[cli-url]: https://github.com/stdlib-js/string-camelcase/tree/cli

[@stdlib/string-camelcase]: https://github.com/stdlib-js/string-camelcase/tree/main



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/string-camelcase/tree/deno

[deno-readme]: https://github.com/stdlib-js/string-camelcase/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/string-camelcase/tree/umd

[umd-readme]: https://github.com/stdlib-js/string-camelcase/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/string-camelcase/tree/esm

[esm-readme]: https://github.com/stdlib-js/string-camelcase/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/string-camelcase/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-camelcase/main/LICENSE



[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams



[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions



[@stdlib/string/constantcase]: https://github.com/stdlib-js/string-constantcase



[@stdlib/string/kebabcase]: https://github.com/stdlib-js/string-kebabcase



[@stdlib/string/pascalcase]: https://github.com/stdlib-js/string-pascalcase



[@stdlib/string/snakecase]: https://github.com/stdlib-js/string-snakecase