doc: add examples for WHATWG URL objects

Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/37822
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
This commit is contained in:
James M Snell committed 2021-03-22 09:34:43 -07:00
1 parent ae595d76e3
commit 0932e90e98
1 file changed
+25
+25
View File
@@ -67,6 +67,31 @@ const myURL =
url.parse('https://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash');
```
### Constructing a URL from component parts and getting the constructed string
It is possible to construct a WHATWG URL from component parts using either the
property setters or a template literal string:
```js
const myURL = new URL('https://example.org');
myURL.pathname = '/a/b/c';
myURL.search = '?d=e';
myURL.hash = '#fgh';
```
```js
const pathname = '/a/b/c';
const search = '?d=e';
const hash = '#fgh';
const myURL = new URL(`https://example.org${pathname}${search}${hash}`);
```
To get the constructed URL string, use the `href` property accessor:
```js
console.log(myURL.href);
```
## The WHATWG URL API
### Class: `URL`