Skip to content

Commit

Permalink
url: add missing documentation for URL.parse()
Browse files Browse the repository at this point in the history
PR-URL: #53733
Reviewed-By: Matthew Aitken <maitken033380023@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
anonrig authored and aduh95 committed Jul 16, 2024
1 parent 3ab8aba commit 1300169
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions doc/api/url.md
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|null}

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 `null`
if `input` is not a valid.

### Class: `URLSearchParams`

<!-- YAML
Expand Down

0 comments on commit 1300169

Please sign in to comment.