update typings to include mini-signals

englercj · Dec 21, 2018 · e9c3c08 · e9c3c08
1 parent 2f365fc
commit e9c3c08
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 18 deletions.
diff --git a/src/Loader.js b/src/Loader.js
@@ -120,7 +120,7 @@ export class Loader {
          *
          * The callback looks like {@link Loader.OnProgressSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Loader.OnProgressSignal>}
          */
         this.onProgress = new Signal();
 
@@ -129,7 +129,7 @@ export class Loader {
          *
          * The callback looks like {@link Loader.OnErrorSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Loader.OnErrorSignal>}
          */
         this.onError = new Signal();
 
@@ -138,7 +138,7 @@ export class Loader {
          *
          * The callback looks like {@link Loader.OnLoadSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Loader.OnLoadSignal>}
          */
         this.onLoad = new Signal();
 
@@ -147,7 +147,7 @@ export class Loader {
          *
          * The callback looks like {@link Loader.OnStartSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Loader.OnStartSignal>}
          */
         this.onStart = new Signal();
 
@@ -156,7 +156,7 @@ export class Loader {
          *
          * The callback looks like {@link Loader.OnCompleteSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Loader.OnCompleteSignal>}
          */
         this.onComplete = new Signal();
 

diff --git a/src/Resource.js b/src/Resource.js
@@ -257,7 +257,7 @@ export class Resource {
          *
          * The callback looks like {@link Resource.OnStartSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Resource.OnStartSignal>}
          */
         this.onStart = new Signal();
 
@@ -270,7 +270,7 @@ export class Resource {
          *
          * The callback looks like {@link Resource.OnProgressSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Resource.OnProgressSignal>}
          */
         this.onProgress = new Signal();
 
@@ -280,7 +280,7 @@ export class Resource {
          *
          * The callback looks like {@link Resource.OnCompleteSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Resource.OnCompleteSignal>}
          */
         this.onComplete = new Signal();
 
@@ -289,7 +289,7 @@ export class Resource {
          *
          * The callback looks like {@link Resource.OnCompleteSignal}.
          *
-         * @member {Signal}
+         * @member {Signal<Resource.OnCompleteSignal>}
          */
         this.onAfterMiddleware = new Signal();
     }

diff --git a/typings/mini-signals.d.ts b/typings/mini-signals.d.ts
@@ -0,0 +1,26 @@
+declare module "mini-signals"
+{
+    namespace MiniSignal
+    {
+        interface MiniSignalBinding
+        {
+            detach(): boolean;
+        }
+    }
+
+    class MiniSignal<CbType>
+    {
+        constructor();
+        handlers(exists: true): boolean;
+        handlers(exists?: false): MiniSignal.MiniSignalBinding[];
+        has(node: MiniSignal.MiniSignalBinding): boolean;
+        add(fn: CbType, thisArg?: any): MiniSignal.MiniSignalBinding;
+        once(fn: CbType, thisArg?: any): MiniSignal.MiniSignalBinding;
+        detach(node: MiniSignal.MiniSignalBinding): MiniSignal<CbType>;
+        detachAll(): MiniSignal<CbType>;
+
+        dispatch: CbType;
+    }
+
+    export = MiniSignal;
+}
diff --git a/typings/resource-loader.d.ts b/typings/resource-loader.d.ts
@@ -1,3 +1,5 @@
+import Signal from 'mini-signals';
+
 declare namespace async {
     function eachSeries(array: any[], iterator: (...params: any[]) => any, callback: (...params: any[]) => any, deferNext?: boolean): void;
     function queue(worker: (...params: any[]) => any, concurrency: number): any;
@@ -18,11 +20,11 @@ declare class Loader {
     resources: {
         [key: string]: Resource;
     };
-    onProgress: Signal;
-    onError: Signal;
-    onLoad: Signal;
-    onStart: Signal;
-    onComplete: Signal;
+    onProgress: Signal<Loader.OnProgressSignal>;
+    onError: Signal<Loader.OnErrorSignal>;
+    onLoad: Signal<Loader.OnLoadSignal>;
+    onStart: Signal<Loader.OnStartSignal>;
+    onComplete: Signal<Loader.OnCompleteSignal>;
     add(name: string, url: string, callback?: Resource.OnCompleteSignal): this;
     add(name: string, url: string, options?: IAddOptions, callback?: Resource.OnCompleteSignal): this;
     add(url: string, callback?: Resource.OnCompleteSignal): this;
@@ -83,10 +85,10 @@ declare class Resource {
     readonly children: Resource[];
     readonly type: Resource.TYPE;
     readonly progressChunk: number;
-    onStart: Signal;
-    onProgress: Signal;
-    onComplete: Signal;
-    onAfterMiddleware: Signal;
+    onStart: Signal<Resource.OnStartSignal>;
+    onProgress: Signal<Resource.OnProgressSignal>;
+    onComplete: Signal<Resource.OnCompleteSignal>;
+    onAfterMiddleware: Signal<Resource.OnCompleteSignal>;
     readonly isDataUrl: boolean;
     readonly isComplete: boolean;
     readonly isLoading: boolean;