@infra-blocks/types 0.6.0-alpha.2 → 0.6.0

package/lib/cjs/events.d.ts

@@ -35,5 +35,14 @@ export interface EmitterLike<E extends Events> {
 export declare class EmitterLikeBase<E extends Events> implements EmitterLike<E> {
     protected readonly emitter: EventEmitter;
     on<Event extends keyof E>(event: Event, handler: E[Event]): this;
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
     protected emit<Event extends keyof E>(event: Event, ...args: Parameters<E[Event]>): boolean;
 }

package/lib/cjs/events.js

@@ -20,6 +20,15 @@ class EmitterLikeBase {
         this.emitter.on(event.toString(), handler);
         return this;
     }
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
     emit(event, ...args) {
         return this.emitter.emit(event.toString(), ...args);
     }

package/lib/cjs/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AA4BvC;;;;;;;;GAQG;AACH,MAAa,eAAe;IACP,OAAO,GAAG,IAAI,qBAAY,EAAE,CAAC;IAEhD,EAAE,CAAwB,KAAY,EAAE,OAAiB;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAES,IAAI,CACZ,KAAY,EACZ,GAAG,IAA0B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF;AAdD,0CAcC"}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AA4BvC;;;;;;;;GAQG;AACH,MAAa,eAAe;IACP,OAAO,GAAG,IAAI,qBAAY,EAAE,CAAC;IAEhD,EAAE,CAAwB,KAAY,EAAE,OAAiB;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACO,IAAI,CACZ,KAAY,EACZ,GAAG,IAA0B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF;AAvBD,0CAuBC"}

package/lib/esm/events.d.ts

@@ -35,5 +35,14 @@ export interface EmitterLike<E extends Events> {
 export declare class EmitterLikeBase<E extends Events> implements EmitterLike<E> {
     protected readonly emitter: EventEmitter;
     on<Event extends keyof E>(event: Event, handler: E[Event]): this;
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
     protected emit<Event extends keyof E>(event: Event, ...args: Parameters<E[Event]>): boolean;
 }

package/lib/esm/events.js

@@ -14,6 +14,15 @@ export class EmitterLikeBase {
         this.emitter.on(event.toString(), handler);
         return this;
     }
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
     emit(event, ...args) {
         return this.emitter.emit(event.toString(), ...args);
     }

package/lib/esm/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AA4BvC;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IACP,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEhD,EAAE,CAAwB,KAAY,EAAE,OAAiB;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAES,IAAI,CACZ,KAAY,EACZ,GAAG,IAA0B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF"}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AA4BvC;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IACP,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEhD,EAAE,CAAwB,KAAY,EAAE,OAAiB;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACO,IAAI,CACZ,KAAY,EACZ,GAAG,IAA0B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/types",
-  "version": "0.6.0-alpha.2",
+  "version": "0.6.0",
   "description": "Typescript types utility package.",
   "keywords": [
     "type",