From e2248b6ef555ce598aacbeb9a8be05f661d463d7 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Mon, 24 Mar 2025 07:35:44 -0400 Subject: [PATCH] chore: properly use `@alias` tag in deprecated utilities --- knip.jsonc | 1 - src/types/utilities.ts | 3 +++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/knip.jsonc b/knip.jsonc index 9a1ac9cd..c0ad5dc3 100644 --- a/knip.jsonc +++ b/knip.jsonc @@ -1,7 +1,6 @@ { "$schema": "https://unpkg.com/knip@5/schema-jsonc.json", "entry": ["src/index.ts!"], - "ignore": ["src/types/utilities.ts"], // https://github.com/webpro-nl/knip/issues/996 "ignoreExportsUsedInFile": { "interface": true, "type": true }, "ignoreMembers": ["finish"], // https://github.com/webpro/knip/issues/414 "include": ["classMembers"], diff --git a/src/types/utilities.ts b/src/types/utilities.ts index 25b96130..fb395146 100644 --- a/src/types/utilities.ts +++ b/src/types/utilities.ts @@ -44,6 +44,7 @@ export function intersectionConstituents(type: ts.Type): ts.Type[] { } /** + * @alias {@link intersectionConstituents} * @deprecated Use {@link intersectionConstituents} instead. * @category Types - Utilities * ``` @@ -294,6 +295,7 @@ export function typeIsLiteral(type: ts.Type): type is ts.LiteralType { } /** + * @alias {@link typeConstituents} * @deprecated Use {@link typeConstituents} instead. * @category Types - Utilities */ @@ -318,6 +320,7 @@ export function unionConstituents(type: ts.Type): ts.Type[] { } /** + * @alias {@link unionConstituents} * @deprecated Use {@link unionConstituents} instead. * @category Types - Utilities */