Skip to content

Commit 65844af

Browse files
Fishrock123rvagg
authored andcommitted
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 aa0f8bf commit 65844af

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/api/url.markdown

+11
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
This module has utilities for URL resolution and parsing.
66
Call `require('url')` to use it.
77

8+
## URL Parsing
9+
810
Parsed URL objects have some or all of the following fields, depending on
911
whether or not they exist in the URL string. Any parts that are not in the URL
1012
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
6466

6567
Example: `'#hash'`
6668

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+
6778
The following methods are provided by the URL module:
6879

6980
## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])

0 commit comments

Comments
 (0)