From 6aa266cd65c27e8fba0298009de77c1aa11090a8 Mon Sep 17 00:00:00 2001
From: Ibrahim Sefer <36334146+Sefibrah@users.noreply.github.com>
Date: Mon, 10 Feb 2025 10:07:24 +0300
Subject: [PATCH] Update README.md
As a small thank you for making this, I made another example for the people showing how it can be implemented in their codebase...
Signed-off-by: Ibrahim Sefer <36334146+Sefibrah@users.noreply.github.com>
---
README.md | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/README.md b/README.md
index c5ef5a6..87d7a37 100644
--- a/README.md
+++ b/README.md
@@ -65,3 +65,31 @@ The package includes the following rules:
| [prefer-takeuntil](docs/rules/prefer-takeuntil.md) | Disallow `subscribe` calls without an accompanying `takeUntil` within Angular components (and, optionally, within services, directives, and pipes). | 💠|
<!-- end auto-generated rules list -->
+
+## Examples
+
+```mjs
+// eslint.json.mjs
+
+import rxjsAngularX from "eslint-plugin-rxjs-angular-x";
+
+export default [
+ {
+ files: ["**/*.ts"],
+ plugins: {
+ "rxjs-angular-x": rxjsAngularX,
+ },
+ rules: {
+ "rxjs-angular-x/prefer-takeuntil": [
+ "error",
+ {
+ checkComplete: false,
+ checkDecorators: ["Component", "Directive", "Injectable"],
+ alias: ["takeUntilDestroyed"],
+ checkDestroy: false,
+ },
+ ],
+ },
+ }
+]
+```