1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: use reserved domains for examples in url.md

Browse Source 
Changes non-reserved domains to reserved ones in url.md.

PR-URL: https://github.com/nodejs/node/pull/23359
Refs: https://www.iana.org/domains/reserved
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Сковорода Никита Андреевич 2018-09-02 15:45:53 +03:00 committed by Daniel Bevenius
parent 4ba1ddb046
commit 0311fcc546
1 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
doc/api/url.md
View File

@ -26,31 +26,31 @@ backwards compatibility with existing applications. New application code
should use the WHATWG API. should use the WHATWG API.
A comparison between the WHATWG and Legacy APIs is provided below. Above the URL A comparison between the WHATWG and Legacy APIs is provided below. Above the URL
`'http://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash'`, properties of `'http://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash'`, properties
an object returned by the legacy `url.parse()` are shown. Below it are of an object returned by the legacy `url.parse()` are shown. Below it are
properties of a WHATWG `URL` object. properties of a WHATWG `URL` object.
WHATWG URL's `origin` property includes `protocol` and `host`, but not WHATWG URL's `origin` property includes `protocol` and `host`, but not
`username` or `password`. `username` or `password`.
```txt ```txt
┌─────────────────────────────────────────────────────────────────────────────────────────────┐ ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ href │ │ href │
├──────────┬──┬─────────────────────┬─────────────────────┬───────────────────────────┬───────┤ ├──────────┬──┬─────────────────────┬────────────────────────┬───────────────────────────┬───────┤
│ protocol │ │ auth │ host │ path │ hash │ │ protocol │ │ auth │ host │ path │ hash │
│ │ │ ├──────────────┬──────┼──────────┬────────────────┤ │ │ │ │ ├─────────────────┬──────┼──────────┬────────────────┤ │
│ │ │ │ hostname │ port │ pathname │ search │ │ │ │ │ │ hostname │ port │ pathname │ search │ │
│ │ │ │ │ │ ├─┬──────────────┤ │ │ │ │ │ │ │ ├─┬──────────────┤ │
│ │ │ │ │ │ │ │ query │ │ │ │ │ │ │ │ │ │ query │ │
" https: // user : pass @ sub.host.com : 8080 /p/a/t/h ? query=string #hash " " https: // user : pass @ sub.example.com : 8080 /p/a/t/h ? query=string #hash "
│ │ │ │ │ hostname │ port │ │ │ │ │ │ │ │ │ hostname │ port │ │ │ │
│ │ │ │ ├──────────────┴──────┤ │ │ │ │ │ │ │ ├─────────────────┴──────┤ │ │ │
│ protocol │ │ username │ password │ host │ │ │ │ │ protocol │ │ username │ password │ host │ │ │ │
├──────────┴──┼──────────┴──────────┼─────────────────────┤ │ │ │ ├──────────┴──┼──────────┴──────────┼────────────────────────┤ │ │ │
│ origin │ │ origin │ pathname │ search │ hash │ │ origin │ │ origin │ pathname │ search │ hash │
├─────────────┴─────────────────────┴─────────────────────┴──────────┴────────────────┴───────┤ ├─────────────┴─────────────────────┴────────────────────────┴──────────┴────────────────┴───────┤
│ href │ │ href │
└─────────────────────────────────────────────────────────────────────────────────────────────┘ └────────────────────────────────────────────────────────────────────────────────────────────────┘
(all spaces in the "" line should be ignored — they are purely for formatting) (all spaces in the "" line should be ignored — they are purely for formatting)
``` ```
@ -58,7 +58,7 @@ Parsing the URL string using the WHATWG API:
```js ```js
const myURL = const myURL =
new URL('https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash'); new URL('https://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash');
``` ```
Parsing the URL string using the Legacy API: Parsing the URL string using the Legacy API:
@ -66,7 +66,7 @@ Parsing the URL string using the Legacy API:
```js ```js
const url = require('url'); const url = require('url');
const myURL = const myURL =
url.parse('https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash'); url.parse('https://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash');
``` ```
## The WHATWG URL API ## The WHATWG URL API
@ -120,8 +120,8 @@ Unicode characters appearing within the hostname of `input` will be
automatically converted to ASCII using the [Punycode][] algorithm. automatically converted to ASCII using the [Punycode][] algorithm.
```js ```js
const myURL = new URL('https://你好你好'); const myURL = new URL('https://測試');
// https://xn--6qqa088eba/ // https://xn--g6w251d/
``` ```
This feature is only available if the `node` executable was compiled with This feature is only available if the `node` executable was compiled with
@ -132,23 +132,23 @@ and a `base` is provided, it is advised to validate that the `origin` of
the `URL` object is what is expected. the `URL` object is what is expected.
```js ```js
let myURL = new URL('http://anotherExample.org/', 'https://example.org/'); let myURL = new URL('http://Example.com/', 'https://example.org/');
// http://anotherexample.org/ // http://example.com/
myURL = new URL('https://anotherExample.org/', 'https://example.org/'); myURL = new URL('https://Example.com/', 'https://example.org/');
// https://anotherexample.org/ // https://example.com/
myURL = new URL('foo://anotherExample.org/', 'https://example.org/'); myURL = new URL('foo://Example.com/', 'https://example.org/');
// foo://anotherExample.org/ // foo://Example.com/
myURL = new URL('http:anotherExample.org/', 'https://example.org/'); myURL = new URL('http:Example.com/', 'https://example.org/');
// http://anotherexample.org/ // http://example.com/
myURL = new URL('https:anotherExample.org/', 'https://example.org/'); myURL = new URL('https:Example.com/', 'https://example.org/');
// https://example.org/anotherExample.org/ // https://example.org/Example.com/
myURL = new URL('foo:anotherExample.org/', 'https://example.org/'); myURL = new URL('foo:Example.com/', 'https://example.org/');
// foo:anotherExample.org/ // foo:Example.com/
``` ```
#### url.hash #### url.hash
@ -249,12 +249,12 @@ console.log(myURL.origin);
``` ```
```js ```js
const idnURL = new URL('https://你好你好'); const idnURL = new URL('https://測試');
console.log(idnURL.origin); console.log(idnURL.origin);
// Prints https://xn--6qqa088eba // Prints https://xn--g6w251d
console.log(idnURL.hostname); console.log(idnURL.hostname);
// Prints xn--6qqa088eba // Prints xn--g6w251d
``` ```
#### url.password #### url.password
@ -929,16 +929,16 @@ any way. The `url.format(URL[, options])` method allows for basic customization
of the output. of the output.
```js ```js
const myURL = new URL('https://a:b@你好你好?abc#foo'); const myURL = new URL('https://a:b@測試?abc#foo');
console.log(myURL.href); console.log(myURL.href);
// Prints https://a:b@xn--6qqa088eba/?abc#foo // Prints https://a:b@xn--g6w251d/?abc#foo
console.log(myURL.toString()); console.log(myURL.toString());
// Prints https://a:b@xn--6qqa088eba/?abc#foo // Prints https://a:b@xn--g6w251d/?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'
``` ```
### url.pathToFileURL(path) ### url.pathToFileURL(path)
@ -999,21 +999,21 @@ For example: `'#hash'`.
The `host` property is the full lower-cased host portion of the URL, including The `host` property is the full lower-cased host portion of the URL, including
the `port` if specified. the `port` if specified.
For example: `'sub.host.com:8080'`. For example: `'sub.example.com:8080'`.
#### urlObject.hostname #### urlObject.hostname
The `hostname` property is the lower-cased host name portion of the `host` The `hostname` property is the lower-cased host name portion of the `host`
component *without* the `port` included. component *without* the `port` included.
For example: `'sub.host.com'`. For example: `'sub.example.com'`.
#### urlObject.href #### urlObject.href
The `href` property is the full URL string that was parsed with both the The `href` property is the full URL string that was parsed with both the
`protocol` and `host` components converted to lower-case. `protocol` and `host` components converted to lower-case.
For example: `'http://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash'`. For example: `'http://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash'`.
#### urlObject.path #### urlObject.path
@ -1282,11 +1282,11 @@ using the [Punycode][] algorithm. Note, however, that a hostname *may* contain
*both* Punycode encoded and percent-encoded characters: *both* Punycode encoded and percent-encoded characters:
```js ```js
const myURL = new URL('https://%CF%80.com/foo'); const myURL = new URL('https://%CF%80.example.com/foo');
console.log(myURL.href); console.log(myURL.href);
// Prints https://xn--1xa.com/foo // Prints https://xn--1xa.example.com/foo
console.log(myURL.origin); console.log(myURL.origin);
// Prints https://π.com // Prints https://π.example.com
``` ```
[`Error`]: errors.html#errors_class_error [`Error`]: errors.html#errors_class_error