Skip to content

doc: refactor WHATWG URL docs #12683

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
TimothyGu wants to merge 2 commits into from
Closed

doc: refactor WHATWG URL docs #12683

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
523b6a1
doc: document url.domainTo* methods separately
TimothyGu Apr 27, 2017
5e48831
doc: add Added-in metadata for WHATWG URL
TimothyGu Apr 27, 2017
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
doc: add Added-in metadata for WHATWG URL
  • Loading branch information
@TimothyGu
TimothyGu committed Apr 27, 2017
commit 5e48831fa9af8fe1cd4585723339d3e4100185f3
26 changes: 25 additions & 1 deletion doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ forward-slash characters (`/`) are required following the colon in the
`protocol`.

## url.domainToASCII(domain)
<!-- YAML
added: v7.4.0
-->

> Stability: 1 - Experimental

Expand All @@ -154,6 +157,9 @@ console.log(url.domainToASCII('xn--iñvalid.com'));
```

## url.domainToUnicode(domain)
<!-- YAML
added: v7.4.0
-->

> Stability: 1 - Experimental

Expand Down Expand Up @@ -243,6 +249,9 @@ The formatting process operates as follows:
* `result` is returned.

## url.format(URL[, options])
<!-- YAML
added: v7.6.0
-->

> Stability: 1 - Experimental

Expand All @@ -254,7 +263,7 @@ The formatting process operates as follows:
fragment, `false` otherwise. Defaults to `true`.
* `search` {boolean} `true` if the serialized URL string should include the
search query, `false` otherwise. Defaults to `true`.
* `unicode` (Boolean) `true` if Unicode characters appearing in the host
* `unicode` {boolean} `true` if Unicode characters appearing in the host
component of the URL string should be encoded directly as opposed to being
Punycode encoded. Defaults to `false`.

Expand Down Expand Up @@ -352,6 +361,9 @@ For example, the ASCII space character (`' '`) is encoded as `%20`. The ASCII
forward slash (`/`) character is encoded as `%3C`.

## The WHATWG URL API
<!-- YAML
added: v7.0.0
-->

> Stability: 1 - Experimental

Expand Down Expand Up @@ -739,6 +751,9 @@ console.log(JSON.stringify(myURLs));
```

### Class: URLSearchParams
<!-- YAML
added: v7.5.0
-->

The `URLSearchParams` API provides read and write access to the query of a
`URL`. The `URLSearchParams` class can also be used standalone with one of the
Expand Down Expand Up @@ -811,6 +826,9 @@ console.log(params.toString());
```

#### Constructor: new URLSearchParams(obj)
<!-- YAML
added: v7.10.0
-->

* `obj` {Object} An object representing a collection of key-value pairs

Expand All @@ -834,6 +852,9 @@ console.log(params.toString());
```

#### Constructor: new URLSearchParams(iterable)
<!-- YAML
added: v7.10.0
-->

* `iterable` {Iterable} An iterable object whose elements are key-value pairs

Expand Down Expand Up @@ -993,6 +1014,9 @@ console.log(params.toString());
```

#### urlSearchParams.sort()
<!-- YAML
added: v7.7.0
-->

Sort all existing name-value pairs in-place by their names. Sorting is done
with a [stable sorting algorithm][], so relative order between name-value pairs
Expand Down