Permalink
Browse files

doc: update url doc to account for escaping

Fixes: #2113
Ref: 17a379e
PR-URL: #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>
  • Loading branch information...
Fishrock123 authored and rvagg committed Aug 28, 2015
1 parent ba50cfe commit 29f586ac0a4e012a9a7838d7dab5c9354fd80c02
Showing with 11 additions and 0 deletions.
  1. +11 −0 doc/api/url.markdown
View
@@ -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])

0 comments on commit 29f586a

Please sign in to comment.