docs(signal): ListenerInterface

Alwatr · Mar 22, 2022 · 44a055b · 44a055b
1 parent 38ef029
commit 44a055b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 5 deletions.
diff --git a/package/signal/README.md b/package/signal/README.md
@@ -200,14 +200,28 @@ Example:
 const listener = contentChangeSignal.addListener((content) => console.log(content));
 ```
 
-### `removeListener(listener)`
+### Listener API Interface
+
+#### `listener.disabled`
+
+Disable the listener, not called anymore.
+
+Example:
+
+```ts
+const listener = contentChangeSignal.addListener((content) => console.log(content));
+...
+listener.disabled = true;
+```
+
+#### `listener.remove()`
 
 Remove listener from specific signal.
 
 Example:
 
 ```ts
-const listenerId = contentChangeSignal.addListener((content) => console.log(content));
+const listener = contentChangeSignal.addListener((content) => console.log(content));
 ...
-contentChangeSignal.removeListener(listenerId);
+listener.remove();
 ```
diff --git a/package/signal/src/signal.ts b/package/signal/src/signal.ts
@@ -249,12 +249,14 @@ export class ListenerInterface<SignalName extends keyof AlwatrSignals> {
   }
 
   /**
-   * Disable signal, all dispatch's ignored (just value updated) and no more listeners will be called.
+   * Disable the listener, not called anymore.
    *
    * Example:
    *
    * ```ts
-   * contentChangeSignal.disabled = true;
+   * const listener = contentChangeSignal.addListener((content) => console.log(content));
+   * ...
+   * listener.disabled = true;
    * ```
    */
   get disabled(): boolean {