evg_observable 1.9.45 → 1.9.47

package/README.md

@@ -6,9 +6,49 @@ EVG Observable
 EVG Observable - is a light library for simple use.
 </p>
 
+## Navigation
+
+- [What is EVG Observable?](#what-is-evg-observable)
+- [Installation](#installation)
+    - [Node.js](#nodejs)
+    - [Browser](#browser)
+- [Usage](#usage)
+    - [Observable simple usage](#observable-simple-usage)
+    - [Browser simple usage](#browser-simple-usage)
+    - [Observable pipe usage](#observable-pipe-usage)
+    - [Ordered observable](#ordered-observable)
+    - [Collector](#collector)
+    - [Advanced Usage Example](#advanced-usage-example)
+- [Methods](#methods)
+    - [Observable](#observable)
+    - [Observable.pipe()](#observablepipe)
+    - [Inbound filters](#inbound-filters)
+    - [Observable subscriber](#observable-subscriber)
+    - [Ordered observable](#ordered-observable-1)
+    - [Ordered observable subscriber](#ordered-observable-subscriber)
+    - [Collector](#collector-1)
+- [License](#license)
+
 ## What is EVG Observable?
 
-EVG Observable is a compact, lightweight library designed for handling asynchronous events. Despite its small size, it offers over 20 powerful techniques for event management.
+EVG Observable is a robust, lightweight library designed for handling asynchronous events. What sets it apart is its
+compact size alongside a wealth of powerful features that facilitate efficient event management. Here are some specific
+features that make it stand out from the rest:
+
+1. **Multi-observable subscription**: With EVG Observable, you are not limited to adding only listeners to your
+   subscribers. Now, you have the option to add other observables as well.
+
+2. **Multi-subscriber capability**: The library allows you to subscribe any number of subscribers to an observable. This
+   works with both listeners and observables.
+
+3. **Extended pipe chain**: The flexibility of EVG Observable extends to pipe chains as well. You can now add any number
+   of filters in a pipe chain whereas previously you were limited to just one.
+
+4. **Inbound and outbound filters**: In addition to existing outbound pipes, the library now supports inbound filters as
+   well, providing you greater control over your data flow.
+
+5. **Flexible switch-case in pipes**: Whether you are dealing with outbound pipes or inbound filters, a flexible
+   switch-case logic has been introduced for better data handling.
 
 ## Installation
 
@@ -19,7 +59,9 @@ EVG Observable is a compact, lightweight library designed for handling asynchron
     $ npm install evg_observable
 
 ### Browser
+
 ```html
+
 <script src="https://unpkg.com/evg_observable/repo/evg_observable.js"></script>
 ```
 
@@ -344,45 +386,190 @@ observable$.next('SOME DATA');
 // To unsubscribe one subscriber, you can use: collector.unsubscribe(subscriber).
 ```
 
+### Advanced Usage Example
+
+The following TypeScript example demonstrates how the extended implementation could be used, incorporating all the new
+updates:
+
+```typescript
+// Import the Observable library
+import {Observable} from "evg_observable/src/outLib/Observable";
+
+// Constants representing different hair colors
+const HAIR = {
+    BLOND: "BLOND",
+    BLACK: "BLACK",
+    BROWN: "BROWN",
+}
+
+// Constants for gender
+const GENDER = {
+    MAN: "MAN",
+    WOMAN: "WOMAN"
+}
+
+// Constants for different occupations
+const MAJOR = {
+    DOCTOR: "DOCTOR",
+    DRIVER: "DRIVER",
+    CHILD: "CHILD",
+}
+
+// Definition of the "Person" class
+class Person {
+    constructor(
+        public name: string,
+        public age: number,
+        public gender: string,
+        public major: string,
+        public hairColor: string) {
+
+        this.hairColor = hairColor;
+        this.name = name;
+        this.age = age;
+        this.gender = gender;
+        this.major = major;
+    }
+}
+
+// Create Observables for individual person, men and women
+const personal$ = new Observable<Person>(null);
+const men$ = new Observable<Person>(null)
+const women$ = new Observable<Person>(null)
+
+// Define various filters to be used later
+const youngAgeFilter = (person: Person) => person.age > 17;
+const oldAgeFilter = (person: Person) => person.age < 60;
+const menFilter = (person: Person) => person.gender === GENDER.MAN;
+const womenFilter = (person: Person) => person.gender === GENDER.WOMAN;
+const blondFilter = (person: Person) => person.hairColor === HAIR.BLOND;
+const blackFilter = (person: Person) => person.hairColor === HAIR.BLACK;
+
+// Callback function to execute when some man is ready to work
+const manReadyToWork = (worker: Person) => {
+    console.log("MAN ==> is ready to work:", worker.name, worker.age, worker.major);
+};
+
+// Callback function to execute when some woman is ready to work
+const womanReadyToWork = (worker: Person) => {
+    console.log("WOMAN ==> is ready to work:", worker.name, worker.age, worker.major);
+};
+
+// Callback function to execute for people with black or blond hair
+const blondAndBlack = (person: Person) => {
+    console.log("PERSON ==> only black or blond:", person.name, person.age, person.hairColor);
+};
+
+// Apply the filters to men$ and women$
+men$.addFilter()
+    .filter(menFilter);
+
+women$.addFilter()
+    .filter(womenFilter);
+
+// Subscribe the callback function to the created Observables
+men$.subscribe(manReadyToWork);
+women$.subscribe(womanReadyToWork);
+
+// Stream the list of people by applying the age filters
+personal$.pipe()
+    .emitByPositive(youngAgeFilter)
+    .emitByPositive(oldAgeFilter)
+    .subscribe([men$, women$]);
+
+// Stream the list of people considering the hair color
+personal$.pipe()
+    .switch()
+    .case(blackFilter)
+    .case(blondFilter)
+    .subscribe(blondAndBlack);
+
+// Start streaming the list of people
+personal$.stream([
+    new Person('Alex', 35, GENDER.MAN, MAJOR.DOCTOR, HAIR.BLOND),
+    new Person('John', 45, GENDER.MAN, MAJOR.DRIVER, HAIR.BLACK),
+    new Person('Alice', 30, GENDER.WOMAN, MAJOR.DOCTOR, HAIR.BROWN),
+    new Person('Sophia', 36, GENDER.WOMAN, MAJOR.DRIVER, HAIR.BLOND),
+    new Person('Matthew', 15, GENDER.MAN, MAJOR.CHILD, HAIR.BROWN),
+    new Person('Emily', 17, GENDER.WOMAN, MAJOR.CHILD, HAIR.BLACK),
+    new Person('James', 40, GENDER.MAN, MAJOR.DOCTOR, HAIR.BLOND),
+    new Person('Emma', 35, GENDER.WOMAN, MAJOR.DRIVER, HAIR.BROWN),
+    new Person('Michael', 15, GENDER.MAN, MAJOR.CHILD, HAIR.BLACK),
+    new Person('Olivia', 16, GENDER.WOMAN, MAJOR.CHILD, HAIR.BLOND)
+]);
+
+// This is the result of handling persons:
+// MAN ==> is ready to work: Alex 35 DOCTOR
+// PERSON ==> only black or blond: Alex 35 BLOND
+// MAN ==> is ready to work: John 45 DRIVER
+// PERSON ==> only black or blond: John 45 BLACK
+// WOMAN ==> is ready to work: Alice 30 DOCTOR
+// WOMAN ==> is ready to work: Sophia 36 DRIVER
+// PERSON ==> only black or blond: Sophia 36 BLOND
+// PERSON ==> only black or blond: Emily 17 BLACK
+// MAN ==> is ready to work: James 40 DOCTOR
+// PERSON ==> only black or blond: James 40 BLOND
+// WOMAN ==> is ready to work: Emma 35 DRIVER
+// PERSON ==> only black or blond: Michael 15 BLACK
+// PERSON ==> only black or blond: Olivia 16 BLOND
+```
+
+In this example, we are using the Observable Library to handle a list of people, applying various filters to deal with
+different scenarios. This flexibility and ability to handle complex, intersecting conditions is what makes EVG
+Observable an invaluable tool for managing asynchronous events.
+Built with the developer's needs in mind, EVG Observable provides a wealth of capabilities at your disposal, making
+event handling a breeze.
+
 ## Methods
 
 ### Observable
 
-| method                     | will return | description |
-|:---------------------------| :--- | :--- |
-| `.subscribe(listener)`     | subscriber | subscribe listener to observable |
-| `.unSubscribe(subscriber)` | void | unsubscribe listener from observable |
-| `.unsubscribeAll()`        | void | unsubscribe all listeners from the current observable |
-| `.next(value)`             | void | emit data to listeners |
-| `.stream(value[])`         | void | pass data to listeners in parts of the array |
-| `.getValue()`              | value | will return the last value sent, or the value that was set during initialization |
-| `.size()`                  | number | will return the current number of subscribers |
-| `.disable()`               | void | disable emission |
-| `.enable()`                | void | enable emission |
-| `.isEnable`                | boolean | read-only field that shows the state of the observer |
-| `.destroy()`               | void | unsubscribe all listeners from the current observable and destroy it |
-| `.isDestroyed`             | boolean | read-only field that shows the kill state of the observer |
-| `.pipe()`                  | pipe condition object | returns an object with which you can customize the subscriber's behavior |
+| method                     | will return           | description                                                                      |
+|:---------------------------|:----------------------|:---------------------------------------------------------------------------------|
+| `.subscribe(listener)`     | subscriber            | subscribe listener to observable                                                 |
+| `.unSubscribe(subscriber)` | void                  | unsubscribe listener from observable                                             |
+| `.unsubscribeAll()`        | void                  | unsubscribe all listeners from the current observable                            |
+| `.next(value)`             | void                  | emit data to listeners                                                           |
+| `.stream(value[])`         | void                  | pass data to listeners in parts of the array                                     |
+| `.getValue()`              | value                 | will return the last value sent, or the value that was set during initialization |
+| `.size()`                  | number                | will return the current number of subscribers                                    |
+| `.disable()`               | void                  | disable emission                                                                 |
+| `.enable()`                | void                  | enable emission                                                                  |
+| `.isEnable`                | boolean               | read-only field that shows the state of the observer                             |
+| `.destroy()`               | void                  | unsubscribe all listeners from the current observable and destroy it             |
+| `.isDestroyed`             | boolean               | read-only field that shows the kill state of the observer                        |
+| `.pipe()`                  | pipe condition object | returns an object with which you can customize the subscriber's behavior         |
 
 ### Observable`.pipe()`
 
-| method | will return | description |
-| :--- | :--- | :--- |
-| `.setOnce()` | pipe subscribe object | observable will send a value to the subscriber only once, and the subscriber will unsubscribe. |
-| `.unsubscribeByNegative(*condition)` | pipe subscribe object | observable will send a value to the subscriber as long as the condition is positive, on the first negative result, the subscriber will unsubscribe |
-| `.unsubscribeByPositive(*condition)` | pipe subscribe object | observable will send a value to the subscriber as long as the condition is negative, on the first positive result, the subscriber will unsubscribe |
-| `.emitByNegative(*condition)` | pipe subscribe object | observable will send a value to the listener only if condition returns "false", there is no automatic unsubscription |
-| `.emitByPositive(*condition)` | pipe subscribe object | observable will send a value to the listener only if condition returns "true", there is no automatic unsubscription |
-| `.emitMatch(*condition)` | pipe subscribe object | observable will send a value to the subscriber only if the return value of the condition matches the data being sent, in this case, there is no automatic unsubscription |
-| `.subscribe(listener)` | subscriber | subscribe listener to observable |
+| method                               | will return       | description                                                                                                                                                                                                             |
+|:-------------------------------------|:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `.setOnce()`                         | pipe object       | observable will send a value to the subscriber only once, and the subscriber will unsubscribe.                                                                                                                          |
+| `.unsubscribeByNegative(*condition)` | pipe object       | observable will send a value to the subscriber as long as the condition is positive, on the first negative result, the subscriber will unsubscribe                                                                      |
+| `.unsubscribeByPositive(*condition)` | pipe object       | observable will send a value to the subscriber as long as the condition is negative, on the first positive result, the subscriber will unsubscribe                                                                      |
+| `.emitByNegative(*condition)`        | pipe object       | observable will send a value to the listener only if condition returns "false", there is no automatic unsubscription                                                                                                    |
+| `.emitByPositive(*condition)`        | pipe object       | observable will send a value to the listener only if condition returns "true", there is no automatic unsubscription                                                                                                     |
+| `.emitMatch(*condition)`             | pipe object       | observable will send a value to the subscriber only if the return value of the condition matches the data being sent, in this case, there is no automatic unsubscription                                                |
+| `.switch()`                          | SwitchCase object | transitions the pipe into switch-case mode. In this mode, only the first condition that returns a positive result is triggered, and all others are ignored. This allows you to handle multiple cases more conveniently. |
+| `.case(*condition)`                  | PipeCase object   | Adds a condition to the chain of cases. The entire chain operates on the principle of "OR". This is different from other pipe methods which, when chained, operate on the principle of "AND".                           |
+| `.subscribe(listener)`               | subscriber        | subscribe listener to observable                                                                                                                                                                                        |
+_*condition_ - this is a function that should return a value that will affect the behavior of the subscriber
+
+### Inbound filters
 
+| Method                | Will Return          | Description                                                                                                                                                                       |
+|:----------------------|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `.addFilter()`        | InboundFilter object | Transitions the Observable into the mode of adding inbound filters.                                                                                                               |
+| `.filter(*condition)` | InboundFilter object | Part of the filter chain that operates on the principle of "AND". If the condition returns `true`, the filter passes the data along the chain.                                    |
+| `.switch()`           | InboundFilter object | Transitions the filter into switch-case mode. In this mode, only the first condition that returns a positive result is triggered, and all others are ignored.                     
+| `.case(*condition)`   | InboundFilter object | Adds a condition to the chain of cases that operate on the principle of "OR". This is different from other filter methods which, when chained, operate on the principle of "AND". |
 _*condition_ - this is a function that should return a value that will affect the behavior of the subscriber
 
 ### Observable subscriber
 
-| method | will return | description |
-| :--- | :--- | :--- |
-| `.unsubscribe()` | void | unsubscribe listener from observable |
+| method           | will return | description                          |
+|:-----------------|:------------|:-------------------------------------|
+| `.unsubscribe()` | void        | unsubscribe listener from observable |
 
 ### Ordered observable
 
@@ -392,24 +579,23 @@ Has the same methods as Observable.
 
 Has the same methods as subscriber. But there is an "order" field and two new methods.
 
-| field | type | description |
-| :--- | :--- | :--- |
+| field    | type   | description                                                                                                                                                                           |
+|:---------|:-------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `.order` | number | Determines the order in which the subscriber is called, the subscriber with the lowest ordinal number is called first, the subscriber with the highest ordinal number is called last. |
 
-
-| method | will return | description                  |
-| :--- | :--- |:-----------------------------|
-| `.setAscendingSort()` | boolean | set order by ascending sort  |
-| `.setDescendingSort()` | boolean | set order by descending sort |
+| method                 | will return | description                  |
+|:-----------------------|:------------|:-----------------------------|
+| `.setAscendingSort()`  | boolean     | set order by ascending sort  |
+| `.setDescendingSort()` | boolean     | set order by descending sort |
 
 ### Collector
 
-| method | will return | description |
-| :--- | :--- | :--- |
-| `.collect( ...subscribers)` | void | collects subscribers |
-| `.unsubscribe(subscriber)` | void | unsubscribe a subscriber from it's observable |
-| `.unsubscribeAll()` | void | unsubscribe all subscribers from their observables |
-| `.destroy()` | void | unsubscribe all subscribers and destroy collector|
+| method                      | will return | description                                        |
+|:----------------------------|:------------|:---------------------------------------------------|
+| `.collect( ...subscribers)` | void        | collects subscribers                               |
+| `.unsubscribe(subscriber)`  | void        | unsubscribe a subscriber from it's observable      |
+| `.unsubscribeAll()`         | void        | unsubscribe all subscribers from their observables |
+| `.destroy()`                | void        | unsubscribe all subscribers and destroy collector  |
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evg_observable",
-  "version": "1.9.45",
+  "version": "1.9.47",
   "description": "Alternative fast and light library version - observable.",
   "directories": {
     "test": "test"

package/src/outLib/Observable.js

@@ -64,9 +64,7 @@ class Observable {
         if (this._isDestroyed)
             return;
         if (this.isNextProcess && listener) {
-            const marker = listener;
-            !marker.isMarkedForUnsubscribe && this.listenersForUnsubscribe.push(listener);
-            marker.isMarkedForUnsubscribe = true;
+            this.listenersForUnsubscribe.push(listener);
             return;
         }
         this.listeners && !(0, FunctionLibs_1.quickDeleteFromArray)(this.listeners, listener);

package/src/outLib/OrderedObservable.js

@@ -38,9 +38,7 @@ class OrderedObservable extends Observable_1.Observable {
         if (this._isDestroyed)
             return;
         if (this.isNextProcess && listener) {
-            const marker = listener;
-            !marker.isMarkedForUnsubscribe && this.listenersForUnsubscribe.push(listener);
-            marker.isMarkedForUnsubscribe = true;
+            this.listenersForUnsubscribe.push(listener);
             return;
         }
         this.listeners && !(0, FunctionLibs_1.deleteFromArray)(this.listeners, listener);

package/src/outLib/SubscribeObject.d.ts

@@ -1,7 +1,6 @@
-import { IErrorCallback, IListener, IMarkedForUnsubscribe, IObserver, ISubscribeGroup, ISubscribeObject, ISubscriptionLike } from "./Types";
+import { IErrorCallback, IListener, IObserver, ISubscribeGroup, ISubscribeObject, ISubscriptionLike } from "./Types";
 import { Pipe } from "./Pipe";
-export declare class SubscribeObject<T> extends Pipe<T> implements ISubscribeObject<T>, IMarkedForUnsubscribe {
-    isMarkedForUnsubscribe: boolean;
+export declare class SubscribeObject<T> extends Pipe<T> implements ISubscribeObject<T> {
     observable: IObserver<T> | undefined;
     listener: IListener<T> | undefined;
     errorHandler: IErrorCallback;

package/src/outLib/SubscribeObject.js

@@ -4,7 +4,6 @@ exports.SubscribeObject = void 0;
 const Pipe_1 = require("./Pipe");
 const FunctionLibs_1 = require("./FunctionLibs");
 class SubscribeObject extends Pipe_1.Pipe {
-    isMarkedForUnsubscribe = false;
     observable;
     listener;
     errorHandler = (errorData, errorMessage) => {

package/src/outLib/Types.d.ts

@@ -1,9 +1,6 @@
 import { SwitchCase } from "./Pipe";
 import { FilterSwitchCase } from "./Filter";
 export type ICallback<T> = (value?: T) => any;
-export type IMarkedForUnsubscribe = {
-    isMarkedForUnsubscribe: boolean;
-};
 export type IErrorCallback = (errorData: any, errorMessage: any) => void;
 export type ISubscribe<T> = {
     subscribe(listener: ISubscribeGroup<T>, errorHandler?: IErrorCallback): ISubscriptionLike | undefined;