time-to-botec/js/node_modules/@stdlib/string/percent-encode/README.md

Percent-encoding

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

Usage

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

Usage

Usage: percent-encode [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ percent-encode ☃
%E2%98%83

To use as a standard stream,

$ echo -n '☃' | percent-encode
%E2%98%83