Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update url doc to account for escaping #2605

Closed
wants to merge 1 commit into from
Closed

doc: update url doc to account for escaping #2605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/url.markdown
View file
Open in desktop
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