fix: Ensure that hooks can compile correctly for ES6 targets using di…

…fferent promise implementations
SierraSoftworks · Jun 9, 2016 · e04e75f · e04e75f
1 parent 8ddb696
commit e04e75f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/lib/Hooks.ts b/lib/Hooks.ts
@@ -1,6 +1,6 @@
 export interface Hooks<TDocument, TInstance> {
-    onCreating? (document: TDocument): Promise<any> | void;
-    onRetrieved? (document: TDocument): Promise<any> | void;
-    onReady? (instance: TInstance): Promise<any> | void;
-    onSaving?(instance: TInstance, changes: any): Promise<any> | void;
+    onCreating? (document: TDocument): Promise<any> | PromiseLike<any> | void;
+    onRetrieved? (document: TDocument): Promise<any> | PromiseLike<any> | void;
+    onReady? (instance: TInstance): Promise<any> | PromiseLike<any> | void;
+    onSaving?(instance: TInstance, changes: any): Promise<any> | PromiseLike<any> | void;
 }
diff --git a/lib/Instance.ts b/lib/Instance.ts
@@ -69,20 +69,20 @@ export class Instance<TDocument extends { _id?: any }, TInstance> {
      * A function which is called whenever a new document is in the process of being inserted into the database.
      * @param document The document which will be inserted into the database.
      */
-    static onCreating: (document: { _id?: any }) => Promise<any> | void;
+    static onCreating: (document: { _id?: any }) => Promise<any> | PromiseLike<any> | void;
 
     /**
      * A function which is called whenever a document of this type is received from the database, prior to it being
      * wrapped by an Instance object.
      * @param document The document that was retrieved from the database.
      */
-    static onRetrieved: (document: { _id?: any }) => Promise<any> | void;
+    static onRetrieved: (document: { _id?: any }) => Promise<any> | PromiseLike<any> | void;
 
     /**
      * A function which is called whenever a new instance has been created to wrap a document.
      * @param instance The instance which has been created.
      */
-    static onReady: (instance: Instance<{ _id?: any }, Instance<{ _id?: any }, any>>) => Promise<any> | void;
+    static onReady: (instance: Instance<{ _id?: any }, Instance<{ _id?: any }, any>>) => Promise<any> | PromiseLike<any> | void;
 
     /**
      * A function which is called whenever an instance's save() method is called to allow you to interrogate and/or manipulate
@@ -91,7 +91,7 @@ export class Instance<TDocument extends { _id?: any }, TInstance> {
      * @param instance The instance to which the changes are being made
      * @param changes The MongoDB change object describing the changes being made to the document.
      */
-    static onSaving: (instance: Instance<{ _id?: any }, Instance<{ _id?: any }, any>>, changes: any) => Promise<any> | void;
+    static onSaving: (instance: Instance<{ _id?: any }, Instance<{ _id?: any }, any>>, changes: any) => Promise<any> | PromiseLike<any> | void;
 
     /**
      * The name of the collection into which documents of this type are stored.

diff --git a/lib/InstanceInterface.ts b/lib/InstanceInterface.ts
@@ -60,7 +60,7 @@ export interface InstanceImplementation<TDocument extends { _id ?: any }, TInsta
      * document inserted into the database. As a result, long running tasks will have a significant impact
      * on the performance of your inserts.
      */
-    onCreating? (document: TDocument): Promise<any> | void;
+    onCreating? (document: TDocument): Promise<any> | PromiseLike<any> | void;
 
     /**
      * An optional method which is called whenever a new document is received from the model's collection and
@@ -74,7 +74,7 @@ export interface InstanceImplementation<TDocument extends { _id ?: any }, TInsta
      * document retrieved from the database. As a result, long running tasks will have a significant impact
      * on the performance of your queries.
      */
-    onRetrieved? (document: TDocument): Promise<any> | void;
+    onRetrieved? (document: TDocument): Promise<any> | PromiseLike<any> | void;
 
     /**
      * An optional method which is called whenever a new document for this model has been wrapped in an instance.
@@ -86,7 +86,7 @@ export interface InstanceImplementation<TDocument extends { _id ?: any }, TInsta
      * document retrieved from the database. As a result, long running tasks will have a significant impact
      * on the performance of your queries.
      */
-    onReady? (instance: TInstance): Promise<any> | void;
+    onReady? (instance: TInstance): Promise<any> | PromiseLike<any> | void;
 
     /**
      * An optional method which is called prior to saving an instance, it is provided with the instance itself as
@@ -101,7 +101,7 @@ export interface InstanceImplementation<TDocument extends { _id ?: any }, TInsta
      * call to save. As a result, long running tasks will have a significant impact on how quickly your save
      * operations are dispatched.
      */
-    onSaving? (instance: TInstance, changes: any): Promise<any> | void;
+    onSaving? (instance: TInstance, changes: any): Promise<any> | PromiseLike<any> | void;
 
     /**
      * The cache controller used to determine whether a document may be cached, as well as deriving a unique cache