From 041f148a65b47eaa5c04571c06f3c7e8892cc5d1 Mon Sep 17 00:00:00 2001 From: Jeremiah Senkpiel Date: Fri, 28 Aug 2015 16:58:18 -0400 Subject: [PATCH] doc: update url doc to account for escaping --- doc/api/url.markdown | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/api/url.markdown b/doc/api/url.markdown index bc54bee360f977..cd4797777f07ec 100644 --- a/doc/api/url.markdown +++ b/doc/api/url.markdown @@ -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])