Commit 29f586a
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>1 parent ba50cfe commit 29f586a
1 file changed
Lines changed: 11 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,6 +5,8 @@ | |||
| 5 | 5 | This module has utilities for URL resolution and parsing. | |
| 6 | 6 | Call `require('url')` to use it. | |
| 7 | 7 | ||
| 8 | + ## URL Parsing | ||
| 9 | + | ||
| 8 | 10 | Parsed URL objects have some or all of the following fields, depending on | |
| 9 | 11 | whether or not they exist in the URL string. Any parts that are not in the URL | |
| 10 | 12 | 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 | |||
| 64 | 66 | ||
| 65 | 67 | Example: `'#hash'` | |
| 66 | 68 | ||
| 69 | + ### Escaped Characters | ||
| 70 | + | ||
| 71 | + Spaces (`' '`) and the following characters will be automatically escaped in the | ||
| 72 | + properties of URL objects: | ||
| 73 | + | ||
| 74 | + < > " ` \r \n \t { } | \ ^ ' | ||
| 75 | + | ||
| 76 | + --- | ||
| 77 | + | ||
| 67 | 78 | The following methods are provided by the URL module: | |
| 68 | 79 | ||
| 69 | 80 | ## url.parse(urlStr[, parseQueryString][, slashesDenoteHost]) | |
0 commit comments