Skip to content

[node] Create @legacy tag instead of @deprecated for legacy API #65506

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
typescript-bot merged 1 commit into from
May 16, 2023
Merged

[node] Create @legacy tag instead of @deprecated for legacy API #65506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions types/node/buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2309,7 +2309,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `Buffer.from(data, 'base64')` instead.
* @legacy Use `Buffer.from(data, 'base64')` instead.
* @param data The Base64-encoded input string.
*/
function atob(data: string): string;
Expand All @@ -2325,7 +2325,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `buf.toString('base64')` instead.
* @legacy Use `buf.toString('base64')` instead.
* @param data An ASCII (Latin1) string.
*/
function btoa(data: string): string;
Expand Down
14 changes: 9 additions & 5 deletions types/node/scripts/generate-docs/ast-processing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ class TagHelper {
return this.createUnknownTag('deprecated', this.fixupCommentFormatting(text, 'deprecated'));
}

createLegacyTag(text: string): JSDocUnknownTag {
return this.createUnknownTag('legacy', this.fixupCommentFormatting(text, 'legacy'));
}

createSeeLinkTag(url: string, text: string): JSDocSeeTag {
const { factory } = this.docContext.transformationContext;
return this.docContext.transformationContext.factory.createJSDocSeeTag(
Expand Down Expand Up @@ -185,7 +189,7 @@ class TagHelper {
tags.push(this.createExperimentalTag());
break;
case Stability.Legacy:
tags.push(this.createDeprecatedTag(stabilityText?.replace('Legacy. ', '') ?? 'Legacy API'));
tags.push(this.createLegacyTag(stabilityText?.replace('Legacy: ', '').replace('Legacy. ', '') ?? 'Legacy API'));
break;
}
return tags;
Expand Down Expand Up @@ -388,7 +392,7 @@ export class NodeProcessingContext {
return {
status: JSDocMatchResult.Ok,
data: {
text: this.fixupDescriptionFormatting(desc, moduleDocs.name),
text: this.fixupDescriptionFormatting(desc, moduleDocs.name),
tags,
}
};
Expand Down Expand Up @@ -516,9 +520,9 @@ export class NodeProcessingContext {
transformationContext.factory.createJSDocComment(processRes.data.text, processRes.data.tags),
node.getSourceFile(),
)
.replaceAll('/**', '')
.replaceAll('*/', '')
.replaceAll(/<(.*?)>/g, '$1');
.replaceAll('/**', '')
.replaceAll('*/', '')
.replaceAll(/<(.*?)>/g, '$1');
const newNode = removeCommentsRecursive(node, transformationContext, typeChecker);
addSyntheticLeadingComment(newNode, SyntaxKind.MultiLineCommentTrivia, jsdoc, true);
} else {
Expand Down
4 changes: 2 additions & 2 deletions types/node/ts4.8/buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2309,7 +2309,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `Buffer.from(data, 'base64')` instead.
* @legacy Use `Buffer.from(data, 'base64')` instead.
* @param data The Base64-encoded input string.
*/
function atob(data: string): string;
Expand All @@ -2325,7 +2325,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `buf.toString('base64')` instead.
* @legacy Use `buf.toString('base64')` instead.
* @param data An ASCII (Latin1) string.
*/
function btoa(data: string): string;
Expand Down
6 changes: 3 additions & 3 deletions types/node/ts4.8/url.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: URL, options?: URLFormatOptions): string;
Expand Down Expand Up @@ -193,7 +193,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: UrlObject | string): string;
Expand Down Expand Up @@ -226,7 +226,7 @@ declare module 'url' {
* resolve('http://example.com/one', '/two'); // 'http://example.com/two'
* ```
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param from The base URL to use if `to` is a relative URL.
* @param to The target URL to resolve.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/node/ts4.8/util.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ declare module 'util' {
* stream.write('With ES6');
* ```
* @since v0.3.0
* @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead.
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
Expand Down
6 changes: 3 additions & 3 deletions types/node/url.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: URL, options?: URLFormatOptions): string;
Expand Down Expand Up @@ -193,7 +193,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: UrlObject | string): string;
Expand Down Expand Up @@ -226,7 +226,7 @@ declare module 'url' {
* resolve('http://example.com/one', '/two'); // 'http://example.com/two'
* ```
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param from The base URL to use if `to` is a relative URL.
* @param to The target URL to resolve.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/node/util.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ declare module 'util' {
* stream.write('With ES6');
* ```
* @since v0.3.0
* @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead.
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
Expand Down
4 changes: 2 additions & 2 deletions types/node/v16/buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2206,7 +2206,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0
* @deprecated Use `Buffer.from(data, 'base64')` instead.
* @legacy Use `Buffer.from(data, 'base64')` instead.
* @param data The Base64-encoded input string.
*/
function atob(data: string): string;
Expand All @@ -2222,7 +2222,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0
* @deprecated Use `buf.toString('base64')` instead.
* @legacy Use `buf.toString('base64')` instead.
* @param data An ASCII (Latin1) string.
*/
function btoa(data: string): string;
Expand Down
4 changes: 2 additions & 2 deletions types/node/v16/ts4.8/buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2206,7 +2206,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0
* @deprecated Use `Buffer.from(data, 'base64')` instead.
* @legacy Use `Buffer.from(data, 'base64')` instead.
* @param data The Base64-encoded input string.
*/
function atob(data: string): string;
Expand All @@ -2222,7 +2222,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0
* @deprecated Use `buf.toString('base64')` instead.
* @legacy Use `buf.toString('base64')` instead.
* @param data An ASCII (Latin1) string.
*/
function btoa(data: string): string;
Expand Down
4 changes: 2 additions & 2 deletions types/node/v16/ts4.8/url.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: UrlObject | string): string;
Expand Down Expand Up @@ -192,7 +192,7 @@ declare module 'url' {
* resolve('http://example.com/one', '/two'); // 'http://example.com/two'
* ```
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param from The Base URL being resolved against.
* @param to The HREF URL being resolved.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/node/v16/ts4.8/util.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ declare module 'util' {
* stream.write('With ES6');
* ```
* @since v0.3.0
* @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead.
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
Expand Down
4 changes: 2 additions & 2 deletions types/node/v16/url.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: UrlObject | string): string;
Expand Down Expand Up @@ -192,7 +192,7 @@ declare module 'url' {
* resolve('http://example.com/one', '/two'); // 'http://example.com/two'
* ```
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param from The Base URL being resolved against.
* @param to The HREF URL being resolved.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/node/v16/util.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ declare module 'util' {
* stream.write('With ES6');
* ```
* @since v0.3.0
* @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead.
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
Expand Down
4 changes: 2 additions & 2 deletions types/node/v18/buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2280,7 +2280,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `Buffer.from(data, 'base64')` instead.
* @legacy Use `Buffer.from(data, 'base64')` instead.
* @param data The Base64-encoded input string.
*/
function atob(data: string): string;
Expand All @@ -2296,7 +2296,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `buf.toString('base64')` instead.
* @legacy Use `buf.toString('base64')` instead.
* @param data An ASCII (Latin1) string.
*/
function btoa(data: string): string;
Expand Down
4 changes: 2 additions & 2 deletions types/node/v18/ts4.8/buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2280,7 +2280,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `Buffer.from(data, 'base64')` instead.
* @legacy Use `Buffer.from(data, 'base64')` instead.
* @param data The Base64-encoded input string.
*/
function atob(data: string): string;
Expand All @@ -2296,7 +2296,7 @@ declare module 'buffer' {
* **For code running using Node.js APIs, converting between base64-encoded strings**
* **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
* @since v15.13.0, v14.17.0
* @deprecated Use `buf.toString('base64')` instead.
* @legacy Use `buf.toString('base64')` instead.
* @param data An ASCII (Latin1) string.
*/
function btoa(data: string): string;
Expand Down
6 changes: 3 additions & 3 deletions types/node/v18/ts4.8/url.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: URL, options?: URLFormatOptions): string;
Expand Down Expand Up @@ -199,7 +199,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: UrlObject | string): string;
Expand Down Expand Up @@ -232,7 +232,7 @@ declare module 'url' {
* resolve('http://example.com/one', '/two'); // 'http://example.com/two'
* ```
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param from The base URL to use if `to` is a relative URL.
* @param to The target URL to resolve.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/node/v18/ts4.8/util.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ declare module 'util' {
* stream.write('With ES6');
* ```
* @since v0.3.0
* @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead.
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
Expand Down
6 changes: 3 additions & 3 deletions types/node/v18/url.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: URL, options?: URLFormatOptions): string;
Expand Down Expand Up @@ -199,7 +199,7 @@ declare module 'url' {
* string, an `Error` is thrown.
* * `result` is returned.
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
*/
function format(urlObject: UrlObject | string): string;
Expand Down Expand Up @@ -232,7 +232,7 @@ declare module 'url' {
* resolve('http://example.com/one', '/two'); // 'http://example.com/two'
* ```
* @since v0.1.25
* @deprecated Legacy: Use the WHATWG URL API instead.
* @legacy Use the WHATWG URL API instead.
* @param from The base URL to use if `to` is a relative URL.
* @param to The target URL to resolve.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/node/v18/util.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ declare module 'util' {
* stream.write('With ES6');
* ```
* @since v0.3.0
* @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead.
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
Expand Down