typescript/no-deprecated Pedantic

💭 This rule requires type information.

What it does

Disallow using code marked as @deprecated.

Why is this bad?

The JSDoc @deprecated tag can be used to document some piece of code being deprecated. It's best to avoid using code marked as deprecated. This rule reports on any references to code marked as @deprecated.

TypeScript recognizes the @deprecated tag, allowing editors to visually indicate deprecated code — usually with a strikethrough. However, TypeScript doesn't report type errors for deprecated code on its own.

Examples

Examples of incorrect code for this rule:

/** @deprecated Use apiV2 instead. */
declare function apiV1(): Promise<string>;
declare function apiV2(): Promise<string>;

await apiV1(); // Using deprecated function

import { parse } from "node:url";
// 'parse' is deprecated. Use the WHATWG URL API instead.
const url = parse("/foo");

Examples of correct code for this rule:

/** @deprecated Use apiV2 instead. */
declare function apiV1(): Promise<string>;
declare function apiV2(): Promise<string>;

await apiV2(); // Using non-deprecated function

// Modern Node.js API, uses `new URL()`
const url2 = new URL("/foo", "http://www.example.com");

Configuration

This rule accepts a configuration object with the following properties:

allow

type: array

default: []

An array of type or value specifiers that are allowed to be used even if deprecated. Use this to allow specific deprecated APIs that you intentionally want to continue using.

allow[n]

type: string

Type or value specifier for matching specific declarations

Supports four types of specifiers:

1. String specifier (deprecated): Universal match by name

"Promise"

2. File specifier: Match types/values declared in local files

{ "from": "file", "name": "MyType" }
{ "from": "file", "name": ["Type1", "Type2"] }
{ "from": "file", "name": "MyType", "path": "./types.ts" }

3. Lib specifier: Match TypeScript built-in lib types

{ "from": "lib", "name": "Promise" }
{ "from": "lib", "name": ["Promise", "PromiseLike"] }

4. Package specifier: Match types/values from npm packages

{ "from": "package", "name": "Observable", "package": "rxjs" }
{ "from": "package", "name": ["Observable", "Subject"], "package": "rxjs" }

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "rules": {
    "typescript/no-deprecated": "error"
  }
}

CLI

oxlint --type-aware --deny typescript/no-deprecated

References

• Rule Source
• Rule Source (tsgolint)