1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: update url doc to account for escaping

Browse Source 
Fixes: https://github.com/nodejs/node/issues/2113
Ref: 17a379ec39a34408477ac6a43751c1b9b2e952a4
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>
This commit is contained in:
Jeremiah Senkpiel 2015-08-28 16:58:18 -04:00 committed by Rod Vagg
parent aa0f8bf455
commit 65844affe9
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/url.markdown
View File

@ -5,6 +5,8 @@
This module has utilities for URL resolution and parsing. This module has utilities for URL resolution and parsing.
Call `require('url')` to use it. Call `require('url')` to use it.
## URL Parsing
Parsed URL objects have some or all of the following fields, depending on 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 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 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'` 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: The following methods are provided by the URL module:
## url.parse(urlStr[, parseQueryString][, slashesDenoteHost]) ## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])