From 9d4bb55bdb7de9b96ebfa7b025a8229fed76961d Mon Sep 17 00:00:00 2001 From: Timothy Gu Date: Wed, 26 Apr 2017 17:41:17 -0700 Subject: [PATCH] doc: add Added-in metadata for WHATWG URL PR-URL: https://github.com/nodejs/node/pull/12683 Reviewed-By: James M Snell Reviewed-By: Daijiro Wachi Reviewed-By: Colin Ihrig Reviewed-By: Joyee Cheung --- doc/api/url.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/doc/api/url.md b/doc/api/url.md index f6f562af4fdb7d..1356e7c038374f 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -132,6 +132,9 @@ forward-slash characters (`/`) are required following the colon in the `protocol`. ## url.domainToASCII(domain) + > Stability: 1 - Experimental @@ -154,6 +157,9 @@ console.log(url.domainToASCII('xn--iƱvalid.com')); ``` ## url.domainToUnicode(domain) + > Stability: 1 - Experimental @@ -243,6 +249,9 @@ The formatting process operates as follows: * `result` is returned. ## url.format(URL[, options]) + > Stability: 1 - Experimental @@ -254,7 +263,7 @@ The formatting process operates as follows: fragment, `false` otherwise. Defaults to `true`. * `search` {boolean} `true` if the serialized URL string should include the search query, `false` otherwise. Defaults to `true`. - * `unicode` (Boolean) `true` if Unicode characters appearing in the host + * `unicode` {boolean} `true` if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to being Punycode encoded. Defaults to `false`. @@ -352,6 +361,9 @@ For example, the ASCII space character (`' '`) is encoded as `%20`. The ASCII forward slash (`/`) character is encoded as `%3C`. ## The WHATWG URL API + > Stability: 1 - Experimental @@ -739,6 +751,9 @@ console.log(JSON.stringify(myURLs)); ``` ### Class: URLSearchParams + The `URLSearchParams` API provides read and write access to the query of a `URL`. The `URLSearchParams` class can also be used standalone with one of the @@ -811,6 +826,9 @@ console.log(params.toString()); ``` #### Constructor: new URLSearchParams(obj) + * `obj` {Object} An object representing a collection of key-value pairs @@ -834,6 +852,9 @@ console.log(params.toString()); ``` #### Constructor: new URLSearchParams(iterable) + * `iterable` {Iterable} An iterable object whose elements are key-value pairs @@ -993,6 +1014,9 @@ console.log(params.toString()); ``` #### urlSearchParams.sort() + Sort all existing name-value pairs in-place by their names. Sorting is done with a [stable sorting algorithm][], so relative order between name-value pairs