Skip to content

Commit

Permalink
doc: revoke deprecation of legacy url, change status to legacy
Browse files Browse the repository at this point in the history
Signed-off-by: James M Snell <[email protected]>
Fixes: #25099

PR-URL: #37784
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Vladimir de Turckheim <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
  • Loading branch information
jasnell authored and targos committed May 1, 2021
1 parent e34aace commit c8383dd
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
5 changes: 4 additions & 1 deletion doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2147,12 +2147,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
Original file line number Diff line number Diff line change
Expand Up @@ -1013,18 +1013,29 @@ pathToFileURL('/some/path%.c'); // Correct: file:///some/path%25.c (POSIX)

## 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.
### 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 @@ -1130,6 +1141,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 @@ -1141,7 +1155,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 @@ -1223,6 +1237,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 @@ -1237,7 +1254,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 @@ -1267,6 +1284,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 @@ -1285,7 +1305,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

0 comments on commit c8383dd

Please sign in to comment.