Skip to content

Commit

Permalink
feat: add OperationHookContext interface
Browse files Browse the repository at this point in the history
Added OperationHookContext interface.

Signed-off-by: Hage Yaapa <hage.yaapa@in.ibm.com>
  • Loading branch information
Hage Yaapa committed Feb 28, 2020
1 parent 36303b3 commit d9abd3c
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions types/observer-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,22 @@
// License text available at https://opensource.org/licenses/MIT

import {Callback, PromiseOrVoid} from './common';
import {PersistedModel, PersistedModelClass} from './persisted-model';

export type Listener = (ctx: object, next: (err?: any) => void) => void;
export interface OperationHookContext<T extends typeof PersistedModel> {
/**
* The constructor of the model that triggered the operation.
*/
Model: T;

/**
* Additional context properties, not typed yet.
* See https://loopback.io/doc/en/lb3/Operation-hooks.html#hooks
*/
[property: string]: any;
}

export type Listener<Ctx> = (ctx: Ctx, next: (err?: any) => void) => void;

export interface ObserverMixin {
/**
Expand Down Expand Up @@ -36,7 +50,7 @@ export interface ObserverMixin {
* `this` set to the model constructor, e.g. `User`.
* @end
*/
observe(operation: string, listener: Listener): void;
observe(operation: string, listener: Listener<OperationHookContext<PersistedModelClass>>): void;

/**
* Unregister an asynchronous observer for the given operation (event).
Expand All @@ -54,7 +68,7 @@ export interface ObserverMixin {
* @callback {function} listener The listener function.
* @end
*/
removeObserver(operation: string, listener: Listener): Listener | undefined;
removeObserver(operation: string, listener: Listener<OperationHookContext<PersistedModelClass>>): Listener<OperationHookContext<PersistedModelClass>> | undefined;

/**
* Unregister all asynchronous observers for the given operation (event).
Expand Down

0 comments on commit d9abd3c

Please sign in to comment.