Skip to content

Commit

Permalink
doc: fix code examples in url.md
Browse files Browse the repository at this point in the history
* Update outputs.
* Refine spaces.
* Restore missing part.

PR-URL: #13288
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
  • Loading branch information
vsemozhetbyt committed May 31, 2017
1 parent ae6c704 commit f1b2e68
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions doc/api/url.md
Expand Up @@ -101,7 +101,7 @@ that an effort will be made to coerce the given values into strings. For
instance: instance:


```js ```js
const myURL = new URL({toString: () => 'https://example.org/'}); const myURL = new URL({ toString: () => 'https://example.org/' });
// https://example.org/ // https://example.org/
``` ```


Expand Down Expand Up @@ -186,6 +186,7 @@ console.log(myURL.href);
// Prints https://example.org/foo // Prints https://example.org/foo


myURL.href = 'https://example.com/bar'; myURL.href = 'https://example.com/bar';
console.log(myURL.href);
// Prints https://example.com/bar // Prints https://example.com/bar
``` ```


Expand Down Expand Up @@ -332,7 +333,7 @@ console.log(myURL.protocol);


myURL.protocol = 'ftp'; myURL.protocol = 'ftp';
console.log(myURL.href); console.log(myURL.href);
// Prints ftp://example.org // Prints ftp://example.org/
``` ```


Invalid URL protocol values assigned to the `protocol` property are ignored. Invalid URL protocol values assigned to the `protocol` property are ignored.
Expand Down Expand Up @@ -380,7 +381,7 @@ console.log(myURL.username);


myURL.username = '123'; myURL.username = '123';
console.log(myURL.href); console.log(myURL.href);
// Prints https://123:xyz@example.com // Prints https://123:xyz@example.com/
``` ```


Any invalid URL characters appearing in the value assigned the `username` Any invalid URL characters appearing in the value assigned the `username`
Expand Down Expand Up @@ -515,7 +516,7 @@ const params = new URLSearchParams({
query: ['first', 'second'] query: ['first', 'second']
}); });
console.log(params.getAll('query')); console.log(params.getAll('query'));
// Prints ['first,second'] // Prints [ 'first,second' ]
console.log(params.toString()); console.log(params.toString());
// Prints 'user=abc&query=first%2Csecond' // Prints 'user=abc&query=first%2Csecond'
``` ```
Expand Down Expand Up @@ -571,7 +572,8 @@ console.log(params.toString());
new URLSearchParams([ new URLSearchParams([
['user', 'abc', 'error'] ['user', 'abc', 'error']
]); ]);
// Throws TypeError: Each query pair must be a name/value tuple // Throws TypeError [ERR_INVALID_TUPLE]:
// Each query pair must be an iterable [name, value] tuple
``` ```


#### urlSearchParams.append(name, value) #### urlSearchParams.append(name, value)
Expand Down Expand Up @@ -816,8 +818,8 @@ console.log(myURL.href);
console.log(myURL.toString()); console.log(myURL.toString());
// Prints https://a:b@xn--6qqa088eba/?abc#foo // Prints https://a:b@xn--6qqa088eba/?abc#foo


console.log(url.format(myURL, {fragment: false, unicode: true, auth: false})); console.log(url.format(myURL, { fragment: false, unicode: true, auth: false }));
// Prints 'https://你好你好?abc' // Prints 'https://你好你好/?abc'
``` ```


## Legacy URL API ## Legacy URL API
Expand Down

0 comments on commit f1b2e68

Please sign in to comment.