From 189e883cb9bef106a5e9163917f5463c2d2c272d Mon Sep 17 00:00:00 2001 From: Ron Buckton Date: Tue, 7 Jul 2020 13:59:21 -0700 Subject: [PATCH] Move deprecated jsdoc tags to compat/deprecations.ts --- src/compat/deprecations.ts | 20 +++++++++++++++++++ src/compiler/corePublic.ts | 2 -- .../reference/api/tsserverlibrary.d.ts | 12 +++++++++-- tests/baselines/reference/api/typescript.d.ts | 12 +++++++++-- 4 files changed, 40 insertions(+), 6 deletions(-) diff --git a/src/compat/deprecations.ts b/src/compat/deprecations.ts index e9a6dc3b9a8..ed1034b7e6a 100644 --- a/src/compat/deprecations.ts +++ b/src/compat/deprecations.ts @@ -1321,4 +1321,24 @@ namespace ts { }); // #endregion Renamed node Tests + + // DEPRECATION: Renamed `Map` and `ReadonlyMap` interfaces + // DEPRECATION PLAN: + // - soft: 4.0 + // - remove: TBD (will remove for at least one release before replacing with `ESMap`/`ReadonlyESMap`) + // - replace: TBD (will eventually replace with `ESMap`/`ReadonlyESMap`) + // #region Renamed `Map` and `ReadonlyMap` interfaces + + /** + * @deprecated Use `ts.ReadonlyESMap` instead. + */ + export interface ReadonlyMap extends ReadonlyESMap { + } + + /** + * @deprecated Use `ts.ESMap` instead. + */ + export interface Map extends ESMap { } + + // #endregion } \ No newline at end of file diff --git a/src/compiler/corePublic.ts b/src/compiler/corePublic.ts index 13ef3346709..dad59377900 100644 --- a/src/compiler/corePublic.ts +++ b/src/compiler/corePublic.ts @@ -45,7 +45,6 @@ namespace ts { /** * ES6 Map interface, only read methods included. - * @deprecated Use `ts.ReadonlyESMap` instead. */ export interface ReadonlyMap extends ReadonlyESMap { } @@ -57,7 +56,6 @@ namespace ts { /** * ES6 Map interface. - * @deprecated Use `ts.ESMap` instead. */ export interface Map extends ESMap { } diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts index 83b03093da4..c185cfdb8af 100644 --- a/tests/baselines/reference/api/tsserverlibrary.d.ts +++ b/tests/baselines/reference/api/tsserverlibrary.d.ts @@ -51,7 +51,6 @@ declare namespace ts { } /** * ES6 Map interface, only read methods included. - * @deprecated Use `ts.ReadonlyESMap` instead. */ interface ReadonlyMap extends ReadonlyESMap { } @@ -61,7 +60,6 @@ declare namespace ts { } /** * ES6 Map interface. - * @deprecated Use `ts.ESMap` instead. */ interface Map extends ESMap { } @@ -10672,6 +10670,16 @@ declare namespace ts { const getMutableClone: (node: T) => T; /** @deprecated Use `isTypeAssertionExpression` instead. */ const isTypeAssertion: (node: Node) => node is TypeAssertion; + /** + * @deprecated Use `ts.ReadonlyESMap` instead. + */ + interface ReadonlyMap extends ReadonlyESMap { + } + /** + * @deprecated Use `ts.ESMap` instead. + */ + interface Map extends ESMap { + } } export = ts; diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts index e85e4a8bf70..b97e67b16db 100644 --- a/tests/baselines/reference/api/typescript.d.ts +++ b/tests/baselines/reference/api/typescript.d.ts @@ -51,7 +51,6 @@ declare namespace ts { } /** * ES6 Map interface, only read methods included. - * @deprecated Use `ts.ReadonlyESMap` instead. */ interface ReadonlyMap extends ReadonlyESMap { } @@ -61,7 +60,6 @@ declare namespace ts { } /** * ES6 Map interface. - * @deprecated Use `ts.ESMap` instead. */ interface Map extends ESMap { } @@ -7092,6 +7090,16 @@ declare namespace ts { const getMutableClone: (node: T) => T; /** @deprecated Use `isTypeAssertionExpression` instead. */ const isTypeAssertion: (node: Node) => node is TypeAssertion; + /** + * @deprecated Use `ts.ReadonlyESMap` instead. + */ + interface ReadonlyMap extends ReadonlyESMap { + } + /** + * @deprecated Use `ts.ESMap` instead. + */ + interface Map extends ESMap { + } } export = ts; \ No newline at end of file