Skip to content

url: add missing documentation for URL.parse() #53733

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

Merged
nodejs-github-bot merged 3 commits into from
Jul 5, 2024
Merged

url: add missing documentation for URL.parse() #53733

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
130e4bb
url: add missing documentation for `URL.parse()`
anonrig Jul 4, 2024
cc6cca8
Update url.md
anonrig Jul 5, 2024
dc40656
Update url.md
anonrig Jul 5, 2024
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
Next Next commit
url: add missing documentation for URL.parse()
  • Loading branch information
@anonrig
anonrig committed Jul 4, 2024
commit 130e4bb7f69d1c508d51708fe0782ff839727c86
17 changes: 17 additions & 0 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,23 @@ const isValid = URL.canParse('/foo', 'https://example.org/'); // true
const isNotValid = URL.canParse('/foo'); // false
```

#### `URL.parse(input[, base])`

<!-- YAML
added: v22.1.0
-->

* `input` {string} The absolute or relative input URL to parse. If `input`
is relative, then `base` is required. If `input` is absolute, the `base`
is ignored. If `input` is not a string, it is [converted to a string][] first.
* `base` {string} The base URL to resolve against if the `input` is not
absolute. If `base` is not a string, it is [converted to a string][] first.
* Returns: {URL|undefined}
Comment thread
anonrig marked this conversation as resolved.
Outdated

Parses a string as a URL. If `base` is provided, it will be used as the base
URL for the purpose of resolving non-absolute `input` URLs. Returns `undefined`
Comment thread
anonrig marked this conversation as resolved.
Outdated
if `input` is not a valid.

### Class: `URLSearchParams`

<!-- YAML
Expand Down