Package Exports
- @stdlib/string-percent-encode
- @stdlib/string-percent-encode/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-percent-encode) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Percent-encoding
Percent-encode a UTF-16 encoded string according to RFC 3986.
Installation
npm install @stdlib/string-percent-encodeUsage
var percentEncode = require( '@stdlib/string-percent-encode' );percentEncode( str )
Percent-encodes a UTF-16 encoded string according to RFC 3986.
var out = percentEncode( '☃' );
// returns '%E2%98%83'Notes
The function percent-encodes an entire
string. Hence, if provided a URI, the function percent-encodes the entire URI.var out = percentEncode( 'https://en.wikipedia.org/wiki/Mode_(statistics)' ); // returns 'https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FMode_%28statistics%29'
To percent-encode a URI, split the URI into separate components, percent-encode relevant components, and then reassemble.
Examples
var percentEncode = require( '@stdlib/string-percent-encode' );
var values;
var out;
var i;
values = [
'Ladies + Gentlemen',
'An encoded string!',
'Dogs, Cats & Mice',
'☃',
'æ',
'𐐷'
];
for ( i = 0; i < values.length; i++ ) {
out = percentEncode( values[ i ] );
console.log( '%s: %s', values[ i ], out );
}CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-percent-encodeUsage
Usage: percent-encode [options] [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.Examples
$ percent-encode ☃
%E2%98%83To use as a standard stream,
$ echo -n '☃' | percent-encode
%E2%98%83Notice
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
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.