update readme and docs

Author: Hypercubed

.gitignore

@@ -28,3 +28,4 @@ node_modules
 
 dist/
 .nyc_output/
+.vscode

.vscode/settings.json

@@ -6,9 +6,6 @@ _(none)_
 ---
 
 ## 2.0.0 (2023-03-29)
-_(none)_
-
-## 2.0.0-2 (2023-03-29)
 
 - `.add` is now type safe.  The type of the listener is checked against the type variable in the constructor as well as an optional "flavor".
 - `.add` now returns a node reference instead of a object.  The returned node cannot be removed directly; it must be from the signal using `MiniSignal#detach`.

CHANGELOG.md

@@ -18,15 +18,16 @@ MiniSignals v2.0.0 has been rewritten in TypeScript and had it's API changed to
 
 New features:
 
-- `.add` now returns a weak node reference which can be used to remove the listener directly from the signal.  Reduces memory leaks.
+- `.add` now returns a node reference which can be used to remove the listener directly from the signal.  Reduces memory leaks.
 - `.add` is now type safe.  The type of the listener is checked against the type variable in the constructor as well as an optional "flavor".
 
 Breaking changes:
 
-- `.add` now returns a node reference instead of a object.  The returned node cannot be removed directly; it must be from the signal using `MiniSignal#detach`.
+- `.add` now returns a node reference instead of an object.  The returned node cannot be removed directly; it must be from the signal using `MiniSignal#detach`.
 - `.once` has been removed.  Use `.add` instead with a call to `.detach` in the callback.
 - The `thisArg` parameter has been removed from `.add`.  Use `.add` with a call to `.bind` or (preferred) use an arrow function with a closure.
 - `.dispatch` now throws an error if the signal is already dispatching.
+`.detach` now throws an error if the node reference was not generated from the signal.
 
 ## Install
 
@@ -36,12 +37,12 @@ Breaking changes:
 npm install mini-signals
 ```
 
-## Example Usage
+## Examples
 
 ```ts
 import { MiniSignal } from 'mini-signals';
 
-const mySignal = new MiniSignal<[string, string]>();  // the type variable is optional and defines the parameters to be dispatched
+const mySignal = new MiniSignal<[string, string]>();  // the type variable optionally and defines the parameters to be dispatched
 
 const binding = mySignal.add((foo: string, bar: string) => { // add listener, note the parameter types match the type variable in the constructor
   console.log('signal dispatched');
@@ -50,10 +51,10 @@ const binding = mySignal.add((foo: string, bar: string) => { // add listener, no
 });
 
 mySignal.dispatch('foo', 'bar'); // dispatch signal passing custom parameters
-binding.detach(); // remove a single listener
+mySignal.detach(binding); // remove a single listener
 ```
 
-## Another Example
+### Another Example
 
 ```ts
 const myObject = {
@@ -70,9 +71,24 @@ myObject.foo = 'baz';
 myObject.updated.dispatch(); // dispatch signal
 ```
 
+### Flavoring the signal
+
+```ts
+import { MiniSignal } from 'mini-signals';
+
+const mySignal = new MiniSignal<[string, string], 'mySignal'>();
+const myOtherSignal = new MiniSignal<[string, string], 'myOtherSignal'>();
+
+const binding = mySignal.add((foo: string, bar: string) => {
+  // ...
+});
+
+myOtherSignal.detach(binding); // TypeScript error: Argument of type 'MiniSignalBinding<[string, string], "mySignal">' is not assignable to parameter of type 'MiniSignalBinding<[string, string], "myOtherSignal">'.
+```
+
 ## API
 
-See [API.md](https://github.com/Hypercubed/mini-signals/blob/master/API.md)
+See [API.md](https://github.com/Hypercubed/mini-signals/blob/master/docs/classes/MiniSignal.md)
 
 ## License
 

README.md

@@ -12,23 +12,24 @@ Custom event/messaging system for TypeScript/JavaScript inspired by [js-signals]
 
 There are several advantages to signals over event-emitters (see [Comparison between different Observer Pattern implementations](https://github.com/millermedeiros/js-signals/wiki/Comparison-between-different-Observer-Pattern-implementations)). However, the current implementation of [js-signals](https://github.com/millermedeiros/js-signals) is (arguably) slow compared to other implementations (see [EventsSpeedTests](https://github.com/Hypercubed/EventsSpeedTests)). `mini-signals` is a fast, minimal emitter, with an API similar to [js-signals](https://github.com/millermedeiros/js-signals).
 
-> Note: Signals here are the type defined by [js-signals](https://github.com/millermedeiros/js-signals) inspired by AS3-Signals.  They should not to be confused with [SolidJS](https://www.solidjs.com/tutorial/introduction_signals) or Angular signals.
+> Note: Signals here are the type defined by Miller Medeiros in [js-signals](https://github.com/millermedeiros/js-signals) inspired by AS3-Signals.  They should not to be confused with [SolidJS](https://www.solidjs.com/tutorial/introduction_signals) or [Angular signals](https://github.com/angular/angular/discussions/49090).
 
 ## mini-signals 2.0.0
 
 MiniSignals v2.0.0 has been rewritten in TypeScript and had it's API changed to improve performance and add type safety.
 
 New features:
 
-- `.add` now returns a weak node reference which can be used to remove the listener directly from the signal.  Reduces memory leaks.
-- `.add` is now type safe.  The type of the listener is checked against the type variable in the constructor.
+- `.add` now returns a node reference which can be used to remove the listener directly from the signal.  Reduces memory leaks.
+- `.add` is now type safe.  The type of the listener is checked against the type variable in the constructor as well as an optional "flavor".
 
 Breaking changes:
 
-- `.add` now returns a node reference instead of a object, which had a `detach` method.  The node reference can be used to remove the listener directly from the signal.
-- `.once` has been removed.  Use `.add` instead with a call to `.detach` in the listener.
-- The `thisArg` parameter has been removed from `.add`.  Use `.add` with a call to `.bind` or use an arrow function with a closure.
+- `.add` now returns a node reference instead of an object.  The returned node cannot be removed directly; it must be from the signal using `MiniSignal#detach`.
+- `.once` has been removed.  Use `.add` instead with a call to `.detach` in the callback.
+- The `thisArg` parameter has been removed from `.add`.  Use `.add` with a call to `.bind` or (preferred) use an arrow function with a closure.
 - `.dispatch` now throws an error if the signal is already dispatching.
+`.detach` now throws an error if the node reference was not generated from the signal.
 
 ## Install
 
@@ -38,12 +39,12 @@ Breaking changes:
 npm install mini-signals
 ```
 
-## Example Usage
+## Examples
 
 ```ts
 import { MiniSignal } from 'mini-signals';
 
-const mySignal = new MiniSignal<[string, string]>();  // the type variable is optional and defines the parameters to be dispatched
+const mySignal = new MiniSignal<[string, string]>();  // the type variable optionally and defines the parameters to be dispatched
 
 const binding = mySignal.add((foo: string, bar: string) => { // add listener, note the parameter types match the type variable in the constructor
   console.log('signal dispatched');
@@ -52,30 +53,44 @@ const binding = mySignal.add((foo: string, bar: string) => { // add listener, no
 });
 
 mySignal.dispatch('foo', 'bar'); // dispatch signal passing custom parameters
-binding.detach(); // remove a single listener
+mySignal.detach(binding); // remove a single listener
 ```
 
-## Another Example
+### Another Example
 
 ```ts
 const myObject = {
   foo: "bar",
-  updated: new MiniSignal<never, typeof myObject>() // in this case the type variable is never, since we are not passing any parameters
+  updated: new MiniSignal<never>() // in this case the type variable is never, since we are not passing any parameters
 };
 
 myObject.updated.add(() => {
   console.log('signal dispatched');
-  assert(this === myObject);
-  assert(this.foo === 'baz');
-}, myObject); // add listener with context
+  assert(myObject.foo === 'baz');
+});
 
 myObject.foo = 'baz';
 myObject.updated.dispatch(); // dispatch signal
 ```
 
+### Flavoring the signal
+
+```ts
+import { MiniSignal } from 'mini-signals';
+
+const mySignal = new MiniSignal<[string, string], 'mySignal'>();
+const myOtherSignal = new MiniSignal<[string, string], 'myOtherSignal'>();
+
+const binding = mySignal.add((foo: string, bar: string) => {
+  // ...
+});
+
+myOtherSignal.detach(binding); // TypeScript error: Argument of type 'MiniSignalBinding<[string, string], "mySignal">' is not assignable to parameter of type 'MiniSignalBinding<[string, string], "myOtherSignal">'.
+```
+
 ## API
 
-See [API.md](https://github.com/Hypercubed/mini-signals/blob/master/API.md)
+See [API.md](https://github.com/Hypercubed/mini-signals/blob/master/docs/classes/MiniSignal.md)
 
 ## License