@artstesh/postboy 3.1.3 → 3.1.4

package/lib/models/postboy-subscription.d.ts

@@ -1,10 +1,39 @@
 import { Observable, Subject } from 'rxjs';
+/**
+ * A class that manages a reactive subscription using a provided Subject and transformation pipe.
+ * Offers methods to interact with the subscription, such as emitting data, completing the subscription,
+ * and accessing the transformed observable.
+ *
+ * @template T The type of data managed by the subscription.
+ */
 export declare class PostboySubscription<T> {
     private subscription;
-    private pipe;
+    private readonly _subscription;
+    /**
+     * Constructs an instance of the class with a given subscription and a transformation pipe.
+     *
+     * @param {Subject<T>} subscription - The source Subject that will be transformed.
+     * @param {(s: Subject<T>) => Observable<T>} pipe - A function that applies a transformation to the subscription.
+     */
     constructor(subscription: Subject<T>, pipe: (s: Subject<T>) => Observable<T>);
+    /**
+     * Returns an observable subscription.
+     *
+     * @return {Observable<T>} An observable instance of type T.
+     */
     sub(): Observable<T>;
+    /**
+     * Triggers an event by emitting the provided data to all subscribers.
+     *
+     * @param {T} data - The data to emit to the subscribers.
+     * @return {void} - Does not return any value.
+     */
     fire(data: T): void;
+    /**
+     * Completes the subscription, signaling that no further values will be sent.
+     * This is typically used to finalize or clean up resources.
+     * @return {void} This method does not return any value.
+     */
     finish(): void;
 }
 //# sourceMappingURL=postboy-subscription.d.ts.map

package/lib/models/postboy-subscription.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postboy-subscription.d.ts","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE3C,qBAAa,mBAAmB,CAAC,CAAC;IAE9B,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,IAAI;gBADJ,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC;IAGzC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;IAIpB,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAInB,MAAM,IAAI,IAAI;CAGtB"}
+{"version":3,"file":"postboy-subscription.d.ts","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE3C;;;;;;GAMG;AACH,qBAAa,mBAAmB,CAAC,CAAC;IAU9B,OAAO,CAAC,YAAY;IATtB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAE9C;;;;;OAKG;gBAEO,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EAChC,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC;IAKxC;;;;OAIG;IACI,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;IAI3B;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAI1B;;;;OAIG;IACI,MAAM,IAAI,IAAI;CAGtB"}

package/lib/models/postboy-subscription.js

@@ -1,17 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostboySubscription = void 0;
+/**
+ * A class that manages a reactive subscription using a provided Subject and transformation pipe.
+ * Offers methods to interact with the subscription, such as emitting data, completing the subscription,
+ * and accessing the transformed observable.
+ *
+ * @template T The type of data managed by the subscription.
+ */
 class PostboySubscription {
+    /**
+     * Constructs an instance of the class with a given subscription and a transformation pipe.
+     *
+     * @param {Subject<T>} subscription - The source Subject that will be transformed.
+     * @param {(s: Subject<T>) => Observable<T>} pipe - A function that applies a transformation to the subscription.
+     */
     constructor(subscription, pipe) {
         this.subscription = subscription;
-        this.pipe = pipe;
+        this._subscription = pipe(subscription);
     }
+    /**
+     * Returns an observable subscription.
+     *
+     * @return {Observable<T>} An observable instance of type T.
+     */
     sub() {
-        return this.pipe(this.subscription);
+        return this._subscription;
     }
+    /**
+     * Triggers an event by emitting the provided data to all subscribers.
+     *
+     * @param {T} data - The data to emit to the subscribers.
+     * @return {void} - Does not return any value.
+     */
     fire(data) {
         this.subscription.next(data);
     }
+    /**
+     * Completes the subscription, signaling that no further values will be sent.
+     * This is typically used to finalize or clean up resources.
+     * @return {void} This method does not return any value.
+     */
     finish() {
         this.subscription.complete();
     }

package/lib/models/postboy-subscription.js.map

@@ -1 +1 @@
-{"version":3,"file":"postboy-subscription.js","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAC9B,YACU,YAAwB,EACxB,IAAsC;QADtC,iBAAY,GAAZ,YAAY,CAAY;QACxB,SAAI,GAAJ,IAAI,CAAkC;IAC7C,CAAC;IAEG,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IAEM,IAAI,CAAC,IAAO;QACjB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;CACF;AAjBD,kDAiBC"}
+{"version":3,"file":"postboy-subscription.js","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,MAAa,mBAAmB;IAG9B;;;;;OAKG;IACH,YACU,YAAwB,EAChC,IAAsC;QAD9B,iBAAY,GAAZ,YAAY,CAAY;QAGhC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,GAAG;QACR,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,IAAO;QACjB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;CACF;AA3CD,kDA2CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artstesh/postboy",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "author": "artstesh",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",