Skip to content

doc: improve WHATWG url constructor code example #32782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lirantal wants to merge 3 commits into from
Closed

doc: improve WHATWG url constructor code example #32782

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7f223e
doc: improve WHATWG url constructor code example
lirantal Apr 11, 2020
df1e5b9
chore: update url constructor example
lirantal Apr 20, 2020
6d5f393
fix: missing lang-code for markdown
lirantal Apr 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: update url constructor example
  • Loading branch information
@lirantal
lirantal committed Apr 20, 2020
commit df1e5b942c3477946bf68b2ff1a17a876816f606
8 changes: 7 additions & 1 deletion doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ WHATWG URL's `origin` property includes `protocol` and `host`, but not
Parsing the URL string using the WHATWG API:

```js
const URL = require('url').URL
const myURL =
new URL('https://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash');
```
Expand Down Expand Up @@ -106,6 +105,13 @@ const myURL = new URL('/foo', 'https://example.org/');
// https://example.org/foo
```

The URL constructor is accessible as a property on the global object.
It can also be imported from the built-in url module:

```
console.log(URL === require('url').URL); // Prints 'true'.
```

A `TypeError` will be thrown if the `input` or `base` are not valid URLs. Note
that an effort will be made to coerce the given values into strings. For
instance:
Expand Down