213 lines
5.0 KiB
Markdown
213 lines
5.0 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2021 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# constantcase
|
|
|
|
> Returns a string converted to a constant case.
|
|
|
|
<!-- Package usage documentation. -->
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var constantcase = require( '@stdlib/string/constantcase' );
|
|
```
|
|
|
|
#### constantcase( str )
|
|
|
|
Converts a string to constant case.
|
|
|
|
```javascript
|
|
var str = constantcase( 'foo bar' );
|
|
// returns 'FOO_BAR'
|
|
|
|
str = constantcase( 'foo bar baz' );
|
|
// returns 'FOO_BAR_BAZ'
|
|
|
|
str = constantcase( 'foo_bar' );
|
|
// returns 'FOO_BAR'
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- Package usage examples. -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
```javascript
|
|
var constantcase = require( '@stdlib/string/constantcase' );
|
|
|
|
var str = 'Hello World!';
|
|
var out = constantcase( str );
|
|
// returns 'HELLO_WORLD'
|
|
|
|
str = 'I am a tiny little teapot';
|
|
out = constantcase( str );
|
|
// returns 'I_AM_A_TINY_LITTLE_TEAPOT'
|
|
|
|
str = 'with big problems';
|
|
out = constantcase( str );
|
|
// returns 'WITH_BIG_PROBLEMS'
|
|
|
|
str = 'To be, or not to be: that is the question.';
|
|
out = constantcase( str );
|
|
// returns 'TO_BE_OR_NOT_TO_BE_THAT_IS_THE_QUESTION'
|
|
|
|
str = 'isMobile';
|
|
out = constantcase( str );
|
|
// returns 'IS_MOBILE'
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
* * *
|
|
|
|
<section class="cli">
|
|
|
|
## CLI
|
|
|
|
<section class="usage">
|
|
|
|
### Usage
|
|
|
|
```text
|
|
Usage: constantcase [options] [<string>]
|
|
|
|
Options:
|
|
|
|
-h, --help Print this message.
|
|
-V, --version Print the package version.
|
|
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="notes">
|
|
|
|
### 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 booP\nisMobile' | constantcase --split /\r?\n/
|
|
|
|
# Escaped...
|
|
$ echo -n $'beEp booP\nisMobile' | constantcase --split /\\r?\\n/
|
|
```
|
|
|
|
- The implementation ignores trailing delimiters.
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
### Examples
|
|
|
|
```bash
|
|
$ constantcase 'hello world'
|
|
HELLO_WORLD
|
|
```
|
|
|
|
To use as a [standard stream][standard-streams],
|
|
|
|
```bash
|
|
$ echo -n 'beEp booP' | constantcase
|
|
BEEP_BOOP
|
|
```
|
|
|
|
To use as a [standard stream][standard-streams],
|
|
|
|
```bash
|
|
$ echo -n 'isMobile' | constantcase
|
|
IS_MOBILE
|
|
```
|
|
|
|
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_boop\tisMobile' | constantcase --split '\t'
|
|
BEEP_BOOP
|
|
IS_MOBILE
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
</section>
|
|
|
|
<!-- /.cli -->
|
|
|
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
|
|
<section class="related">
|
|
|
|
* * *
|
|
|
|
## See Also
|
|
|
|
- <span class="package-name">[`@stdlib/string/camelcase`][@stdlib/string/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
|
|
- <span class="package-name">[`@stdlib/string/kebabcase`][@stdlib/string/kebabcase]</span><span class="delimiter">: </span><span class="description">convert a string to kebab case.</span>
|
|
- <span class="package-name">[`@stdlib/string/pascalcase`][@stdlib/string/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
|
|
- <span class="package-name">[`@stdlib/string/snakecase`][@stdlib/string/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
|
|
|
|
</section>
|
|
|
|
<!-- /.related -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
|
|
|
|
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
|
|
|
<!-- <related-links> -->
|
|
|
|
[@stdlib/string/camelcase]: https://github.com/stdlib-js/string/tree/main/camelcase
|
|
|
|
[@stdlib/string/kebabcase]: https://github.com/stdlib-js/string/tree/main/kebabcase
|
|
|
|
[@stdlib/string/pascalcase]: https://github.com/stdlib-js/string/tree/main/pascalcase
|
|
|
|
[@stdlib/string/snakecase]: https://github.com/stdlib-js/string/tree/main/snakecase
|
|
|
|
<!-- </related-links> -->
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|