@yuuvis/client-core 2.4.4 → 2.5.0

package/lib/service/event/event.interface.d.ts

@@ -1,15 +1,18 @@
 /**
  * Triggerable and Subscribable events
+ * 1 & T creates an intersection of the literal type 1 and type T, this results in never since nothing can be both 1 and string except for any.
+ * 0 dose not extends never or 1, so if T is any, the condition resolves to true.
  */
-export interface YuvEvent {
+export type IsAny<T> = 0 extends 1 & T ? true : false;
+export interface YuvEvent<D = any> {
     /**
      * type
      */
     type: string;
     /**
-     * data to be passed along with the event
+     * data to be passed along with the event if T is 'any' data is optional
      */
-    data?: any;
+    data: IsAny<D> extends true ? D | undefined : D;
 }
 /**
  * Mandatory Custom event prefix for all custom YUV events
@@ -24,3 +27,10 @@ export interface YuvMessage {
     timestamp: number;
     source: string;
 }
+/**
+ * Generic call-signature for triggering events.
+ * - If `T` is `string`, the `type` parameter will be that string literal type.
+ * - If `T` is `any`, the `data` parameter will be optional.
+ * - Otherwise `data` is required.
+ */
+export type Trigger = <T = any>(type: T extends string ? T : string, ...data: IsAny<T> extends true ? [data?: T] : [data: T]) => void;

package/lib/service/event/event.service.d.ts

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { YuvEvent } from './event.interface';
+import { YuvEvent, IsAny } from './event.interface';
 import * as i0 from "@angular/core";
 /**
  * Service for providing triggered events
@@ -19,12 +19,12 @@ export declare class EventService {
      * @param type Type/key of the event
      * @param data Data to be send along with the event
      */
-    trigger(type: string, data?: any): void;
+    trigger<T extends string = any, D = any>(type: IsAny<T> extends true ? string : T, ...args: IsAny<D> extends true ? [data?: D] : [data: D]): void;
     /**
      * Listen on a triggered event
      * @param types Type/key of the event
      */
-    on(...types: string[]): Observable<YuvEvent>;
+    on<T extends string = any, D = any>(...types: (IsAny<T> extends true ? string : T)[]): Observable<YuvEvent<D>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<EventService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EventService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuuvis/client-core",
-  "version": "2.4.4",
+  "version": "2.5.0",
   "author": "OPTIMAL SYSTEMS GmbH <npm@optimal-systems.de>",
   "license": "MIT",
   "peerDependencies": {