Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/string-percent-encode
Percent-encode a UTF-16 encoded string according to RFC 3986.
https://github.com/stdlib-js/string-percent-encode
encode encoding javascript node node-js nodejs percent percent-encode percent-encoding stdlib str string utf-16 utf-8 utf16 utf8 util utilities utility utils
Last synced: 9 days ago
JSON representation
Percent-encode a UTF-16 encoded string according to RFC 3986.
- Host: GitHub
- URL: https://github.com/stdlib-js/string-percent-encode
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:16:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T03:24:33.000Z (2 months ago)
- Last Synced: 2025-01-01T16:22:37.070Z (about 1 month ago)
- Topics: encode, encoding, javascript, node, node-js, nodejs, percent, percent-encode, percent-encoding, stdlib, str, string, utf-16, utf-8, utf16, utf8, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 896 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!
# percentEncode
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Percent-encode][percent-encoding] a [UTF-16][utf-16] encoded string according to [RFC 3986][rfc-3986-percent-encoding].
## Installation
```bash
npm install @stdlib/string-percent-encode
```
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 percentEncode = require( '@stdlib/string-percent-encode' );
```
#### percentEncode( str )
[Percent-encodes][percent-encoding] a [UTF-16][utf-16] encoded string according to [RFC 3986][rfc-3986-percent-encoding].
```javascript
var out = percentEncode( '☃' );
// returns '%E2%98%83'
```
## Notes
- The function [percent-encodes][percent-encoding] an **entire** string. Hence, if provided a URI, the function [percent-encodes][percent-encoding] the entire URI.
```javascript
var out = percentEncode( 'https://en.wikipedia.org/wiki/Mode_(statistics)' );
// returns 'https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FMode_%28statistics%29'
```
To [percent-encode][percent-encoding] a URI, split the URI into separate components, [percent-encode][percent-encoding] relevant components, and then reassemble.
## Examples
```javascript
var percentEncode = require( '@stdlib/string-percent-encode' );
var values = [
'Ladies + Gentlemen',
'An encoded string!',
'Dogs, Cats & Mice',
'☃',
'æ',
'𐐷'
];
var i;
for ( i = 0; i < values.length; i++ ) {
console.log( '%s: %s', values[ i ], percentEncode( values[ i ] ) );
}
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/string-percent-encode-cli
```
### Usage
```text
Usage: percent-encode [options] []
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
### Examples
```bash
$ percent-encode ☃
%E2%98%83
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n '☃' | percent-encode
%E2%98%83
```
* * *
## 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-percent-encode.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-percent-encode
[test-image]: https://github.com/stdlib-js/string-percent-encode/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/string-percent-encode/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-percent-encode/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-percent-encode?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-percent-encode#cli
[cli-url]: https://github.com/stdlib-js/string-percent-encode/tree/cli
[@stdlib/string-percent-encode]: https://github.com/stdlib-js/string-percent-encode/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-percent-encode/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-percent-encode/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-percent-encode/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-percent-encode/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-percent-encode/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-percent-encode/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-percent-encode/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-percent-encode/main/LICENSE
[percent-encoding]: https://en.wikipedia.org/wiki/Percent-encoding
[rfc-3986-percent-encoding]: https://tools.ietf.org/html/rfc3986#section-2.1
[utf-16]: https://en.wikipedia.org/wiki/UTF-16
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams