encodeurl
Encode a URL to a percent-encoded form, excluding already-encoded sequences
Installation
This is a Node.js module available through the npm registry. Installation is done using the npm install
command:
API
encodeUrl(url)
Encode a URL to a percent-encoded form, excluding already-encoded sequences.
This function will take an already-encoded URL and encode all the non-URL code points (as UTF-8 byte sequences). This function will not encode the "%" character unless it is not part of a valid sequence (%20
will be left as-is, but %foo
will be encoded as %25foo
).
This encode is meant to be "safe" and does not throw errors. It will try as hard as it can to properly encode the given URL, including replacing any raw, unpaired surrogate pairs with the Unicode replacement character prior to encoding.
This function is similar to the intrinsic function encodeURI
, except it will not encode the %
character if that is part of a valid sequence, will not encode [
and ]
(for IPv6 hostnames) and will replace raw, unpaired surrogate pairs with the Unicode replacement character (instead of throwing).
Examples
Encode a URL containing user-controled data
Encode a URL for use in a header field
Testing
References
License
Last updated