1. ホーム
  2. typescript

[解決済み] typescriptで非推奨のマークを付けることは可能ですか?

2022-12-14 12:32:06

質問

非推奨のメソッドを持つJavascript APIのtypescript定義を書いています。以下はドキュメントの抜粋です(彼らはAPIと言いますが、それはこの単一のメソッドについてだけです)。

このAPIは何の効果もありません。これは互換性のために維持されています。 のために維持されています。

互換性のために、私はこのメソッドを定義ファイルで文書化したいと思います。しかし、可能であれば、私はそれが非推奨であることを何らかの形で伝えたいと思います。

私の現在の問題は、定義ファイルでの非推奨についてのみですが、私は他のコードでこの機能を使用したいと思います。したがって、質問はより一般的なものです。typescript で何かを非推奨としてマークするにはどうしたらよいでしょうか。

どのように解決するのですか?

JSDocコメントを使用して、非推奨のコードをマークすることができます。

/**
 * @deprecated The method should not be used
 */
export const oldFunc = () => {}

また このeslintのルール は非推奨のメソッドに目を通し、その使用法について警告を出すことができます。