Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/string-headercase
Convert a string to HTTP header case.
https://github.com/stdlib-js/string-headercase
case convert header headercase http javascript node node-js nodejs stdlib str string util utilities utility utils
Last synced: 15 days ago
JSON representation
Convert a string to HTTP header case.
- Host: GitHub
- URL: https://github.com/stdlib-js/string-headercase
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-07-20T00:09:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-01T05:25:26.000Z (about 1 month ago)
- Last Synced: 2024-10-15T03:21:38.633Z (23 days ago)
- Topics: case, convert, header, headercase, http, javascript, node, node-js, nodejs, stdlib, str, string, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 648 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!
# headercase
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert a string to HTTP header case.
## Installation
```bash
npm install @stdlib/string-headercase
```
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 headercase = require( '@stdlib/string-headercase' );
```
#### headercase( str )
Converts a string to HTTP header case.
```javascript
var out = headercase( 'foo bar' );
// returns 'Foo-Bar'
out = headercase( 'IS_MOBILE' );
// returns 'Is-Mobile'
out = headercase( 'Hello World!' );
// returns 'Hello-World'
out = headercase( '--foo-bar--' );
// returns 'Foo-Bar'
```
## Examples
```javascript
var headercase = require( '@stdlib/string-headercase' );
var str = 'Hello World!';
var out = headercase( str );
// returns 'Hello-World'
str = 'HELLO WORLD!';
out = headercase( str );
// returns 'Hello-World'
str = 'To be, or not to be: that is the question.';
out = headercase( str );
// returns 'To-Be-Or-Not-To-Be-That-Is-The-Question'
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/string-headercase-cli
```
### Usage
```text
Usage: headercase [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' | headercase --split /\r?\n/
# Escaped...
$ echo -n $'beep\nfoo_bar' | headercase --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
### Examples
```bash
$ headercase 'hello world!'
Hello-World
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n 'beEp booP' | headercase
Beep-Boop
```
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' | headercase --split '\t'
Beep
Foo-Bar
```
* * *
## See Also
- [`@stdlib/string-camelcase`][@stdlib/string/camelcase]: convert a string to camel 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-headercase.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-headercase
[test-image]: https://github.com/stdlib-js/string-headercase/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/string-headercase/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-headercase/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-headercase?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-headercase#cli
[cli-url]: https://github.com/stdlib-js/string-headercase/tree/cli
[@stdlib/string-headercase]: https://github.com/stdlib-js/string-headercase/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-headercase/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-headercase/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-headercase/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-headercase/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-headercase/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-headercase/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-headercase/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-headercase/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/camelcase]: https://github.com/stdlib-js/string-camelcase
[@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