Browse Source

doc: update url doc to account for escaping

Fixes: https://github.com/nodejs/node/issues/2113
Ref: 17a379ec39
PR-URL: https://github.com/nodejs/node/pull/2605
Reviewed-By: jasnell - James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: mscdex - Brian White <mscdex@mscdex.net>
v4.x
Jeremiah Senkpiel 9 years ago
committed by Rod Vagg
parent
commit
29f586ac0a
  1. 11
      doc/api/url.markdown

11
doc/api/url.markdown

@ -5,6 +5,8 @@
This module has utilities for URL resolution and parsing.
Call `require('url')` to use it.
## URL Parsing
Parsed URL objects have some or all of the following fields, depending on
whether or not they exist in the URL string. Any parts that are not in the URL
string will not be in the parsed object. Examples are shown for the URL
@ -64,6 +66,15 @@ string will not be in the parsed object. Examples are shown for the URL
Example: `'#hash'`
### Escaped Characters
Spaces (`' '`) and the following characters will be automatically escaped in the
properties of URL objects:
< > " ` \r \n \t { } | \ ^ '
---
The following methods are provided by the URL module:
## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])

Loading…
Cancel
Save