Skip to content

doc: add legacy status #37784

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
jasnell wants to merge 3 commits into from
Closed

doc: add legacy status #37784

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4d3377
doc: add legacy status to stability index
jasnell Mar 17, 2021
c22762c
doc: revoke deprecation of legacy url, change status to legacy
jasnell Mar 17, 2021
dcc2345
doc: apply style for legacy status
jasnell Mar 19, 2021
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
doc: revoke deprecation of legacy url, change status to legacy 
Signed-off-by: James M Snell <jasnell@gmail.com>
Fixes: #25099
  • Loading branch information
@jasnell
jasnell committed Mar 19, 2021
commit c22762c66c58bb6112b11c13a2041ef4098bced1
5 changes: 4 additions & 1 deletion doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2172,12 +2172,15 @@ future release.
### DEP0116: Legacy URL API
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: Documentation-only deprecation.
-->

Type: Documentation-only
Type: Deprecation revoked

The [Legacy URL API][] is deprecated. This includes [`url.format()`][],
[`url.parse()`][], [`url.resolve()`][], and the [legacy `urlObject`][]. Please
Expand Down
30 changes: 25 additions & 5 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1075,18 +1075,29 @@ console.log(urlToHttpOptions(myUrl));

## Legacy URL API
<!-- YAML
deprecated: v11.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: This API is deprecated.
-->

> Stability: 3 - Legacy: Use the WHATWG URL API instead.
Comment thread
jasnell marked this conversation as resolved.
Resolved

### Legacy `urlObject`
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
-->

> Stability: 0 - Deprecated: Use the WHATWG URL API instead.
> Stability: 3 - Legacy: Use the WHATWG URL API instead.

The legacy `urlObject` (`require('url').Url`) is created and returned by the
`url.parse()` function.
Expand Down Expand Up @@ -1192,6 +1203,9 @@ forward-slash characters (`/`) are required following the colon in the
<!-- YAML
added: v0.1.25
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
Expand All @@ -1203,7 +1217,7 @@ changes:
times.
-->

> Stability: 0 - Deprecated: Use the WHATWG URL API instead.
> Stability: 3 - Legacy: Use the WHATWG URL API instead.

* `urlObject` {Object|string} A URL object (as returned by `url.parse()` or
constructed otherwise). If a string, it is converted to an object by passing
Expand Down Expand Up @@ -1285,6 +1299,9 @@ The formatting process operates as follows:
<!-- YAML
added: v0.1.25
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.14.0
pr-url: https://github.com/nodejs/node/pull/26941
description: The `pathname` property on the returned URL object is now `/`
Expand All @@ -1299,7 +1316,7 @@ changes:
when no query string is present.
-->

> Stability: 0 - Deprecated: Use the WHATWG URL API instead.
> Stability: 3 - Legacy: Use the WHATWG URL API instead.

* `urlString` {string} The URL string to parse.
* `parseQueryString` {boolean} If `true`, the `query` property will always
Expand Down Expand Up @@ -1329,6 +1346,9 @@ incorrect handling of usernames and passwords have been identified.
<!-- YAML
added: v0.1.25
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
Expand All @@ -1347,7 +1367,7 @@ changes:
contains a hostname.
-->

> Stability: 0 - Deprecated: Use the WHATWG URL API instead.
> Stability: 3 - Legacy: Use the WHATWG URL API instead.

* `from` {string} The Base URL being resolved against.
* `to` {string} The HREF URL being resolved.
Expand Down