percentEncode

Percent-encode a UTF-16 encoded string according to RFC 3986.

Installation

npm install @stdlib/string-base-percent-encode

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch.
• If you are using Deno, visit the deno branch.
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

Usage

var percentEncode = require( '@stdlib/string-base-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-base-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 ] ) );
}

---

Notice

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-2023. The Stdlib Authors.