From 9a9063316338d24b9675f2a7fc2a8308a2d08881 Mon Sep 17 00:00:00 2001 From: rhysd Date: Fri, 17 May 2024 12:15:13 +0900 Subject: [PATCH] docs: add TypeScript support section --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d2b77ec..f9d866d 100644 --- a/README.md +++ b/README.md @@ -82,3 +82,15 @@ npm test | [detect-unsafe-regex](docs/rules/detect-unsafe-regex.md) | Detects potentially unsafe regular expressions, which may take a very long time to run, blocking the event loop. | ✅ | + +## TypeScript support + +Type definitions for this package are managed by [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped). Use [@types/eslint-plugin-security](https://www.npmjs.com/package/@types/eslint-plugin-security) for type checking. + +```sh +npm install --save-dev @types/eslint-plugin-security + +# OR + +yarn add --dev @types/eslint-plugin-security +```