Class EventNotificationRequest

Hierarchy

EventNotificationRequest

Index

Constructors

constructor

Properties

Methods

handleUpdate

Constructors

constructor

new EventNotificationRequest(callbackFunction: function, eventPredicate: function, firstTriggerOnly?: boolean, userData?: any): EventNotificationRequest

- Defined in io.ts:50
Parameters
- callbackFunction: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
- eventPredicate: function
  - - (userData?: any): boolean
    - Parameters
      - Optional userData: any
      Returns boolean
- Default value firstTriggerOnly: boolean = true
- Optional userData: any
Returns EventNotificationRequest

Properties

Private callbackFunction

callbackFunction: function

Type declaration

- (err?: Error): void
- Parameters
  - Optional err: Error
  Returns void

Private eventPredicate

eventPredicate: function

Type declaration

- (userData?: any): boolean
- Parameters
  - Optional userData: any
  Returns boolean

Private firstTriggerOnly

firstTriggerOnly: boolean

Private userData

userData: any

Methods

handleUpdate

handleUpdate(): boolean

- Defined in io.ts:65
Calls this event's predicate and invokes its callback if the predicate signals for the event to fire. Returns a boolean indicating whether the event should continue to be updated.

Returns boolean

Generated using TypeDoc