Skip to content

Commit

Permalink
doc: update url doc to account for escaping
Browse files Browse the repository at this point in the history
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 committed Sep 3, 2015
1 parent 6ce8f5f commit 47e5cf7
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/api/url.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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])
Expand Down

0 comments on commit 47e5cf7

Please sign in to comment.