Class EventEmitter

This is the primary class in IronBeam. This class should be used as a replacement for events.EventEmitter in node

Hierarchy

EventEmitter

Implements

IEventEmitter

Index

Constructors

constructor

Properties

Constructors

constructor

new EventEmitter(opts?: IIronBeamOptions): EventEmitter

- Defined in iron-beam.ts:107
Parameters
- Optional opts: IIronBeamOptions
  
  Must pass in IIronBeamOptions.
Returns EventEmitter

Properties

Private annotation

annotation: any

defaultMaxListeners

defaultMaxListeners: number

Private delimiter

delimiter: string

Private interceptorTree

interceptorTree: Tree<IIntercept>

Private listenerTree

listenerTree: Tree<IListener>

Private maxListeners

maxListeners: number

Private wildcard

wildcard: string

Methods

addListener

addListener(eventName: string, method: Function): EventEmitter

Implementation of IEventEmitter.addListener
- Defined in iron-beam.ts:168
Parameters
- eventName: string
- method: Function
Returns EventEmitter

Private addNewListener

addNewListener(listener: IListener, method: Function): this

- Defined in iron-beam.ts:182
Parameters
- listener: IListener
- method: Function
Returns this

allAnnotatedListeners

allAnnotatedListeners(anno?: any, eventName?: string): IListener[]

Implementation of IEventEmitter.allAnnotatedListeners
- Defined in iron-beam.ts:391
Parameters
- Optional anno: any
- Optional eventName: string
Returns IListener[]

allInterceptors

allInterceptors(): IInterceptors[]

Implementation of IEventEmitter.allInterceptors
- Defined in iron-beam.ts:405
Returns IInterceptors[]

allListeners

allListeners(): IListener[]

Implementation of IEventEmitter.allListeners
- Defined in iron-beam.ts:387
Returns IListener[]

annotate

annotate(anno: any): EventEmitter

Implementation of IEventEmitter.annotate
- Defined in iron-beam.ts:154
´annotate´ allows an object to be set for any listener/emitter that will be available in any ´anno´ property.

Parameters
- anno: any
  
  ´anno´ is any object that needs to used by listeners/emitters/interceptors
Returns EventEmitter

Returns EventEmitter for chaining.

annotatedListeners

annotatedListeners(eventName: string, anno?: any): IListener[]

Implementation of IEventEmitter.annotatedListeners
- Defined in iron-beam.ts:383
Parameters
- eventName: string
- Optional anno: any
Returns IListener[]

Private callPost

callPost(method: string, intercepts: IIntercept[], anno: any, args: any[], cb: function): void

- Defined in iron-beam.ts:314
Parameters
- method: string
- intercepts: IIntercept[]
- anno: any
- args: any[]
- cb: function
  - - (e: Error, result?: any): void
    - Parameters
      - e: Error
      - Optional result: any
      Returns void
Returns void

Private callPre

callPre(method: string, intercepts: IIntercept[], anno: any, args: any[], cb: function): void

- Defined in iron-beam.ts:283
Parameters
- method: string
- intercepts: IIntercept[]
- anno: any
- args: any[]
- cb: function
  - - (e: Error, result: any): void
    - Parameters
      - e: Error
      - result: any
      Returns void
Returns void

dispose

dispose(callback?: function): void

- Defined in iron-beam.ts:409
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void

emit

emit(eventName: string, ...args: any[]): boolean

Implementation of IEventEmitter.emit
- Defined in iron-beam.ts:198
Parameters
- eventName: string
- Rest ...args: any[]
Returns boolean

hasListener

hasListener(eventName: string): boolean

Implementation of IEventEmitter.hasListener
- Defined in iron-beam.ts:379
Parameters
- eventName: string
Returns boolean

intercept

intercept(eventName: string, interceptors: IInterceptors): IEventEmitter

Implementation of IEventEmitter.intercept
- Defined in iron-beam.ts:275
Parameters
- eventName: string
- interceptors: IInterceptors
Returns IEventEmitter

listeners

listeners(eventName: string): Function[]

Implementation of IEventEmitter.listeners
- Defined in iron-beam.ts:374
Parameters
- eventName: string
Returns Function[]

on

on(eventName: string, method: Function): EventEmitter

Implementation of IEventEmitter.on
- Defined in iron-beam.ts:159
Parameters
- eventName: string
- method: Function
Returns EventEmitter

once

once(eventName: string, method: Function): EventEmitter

Implementation of IEventEmitter.once
- Defined in iron-beam.ts:172
Parameters
- eventName: string
- method: Function
Returns EventEmitter

removeAllAnnotatedListeners

removeAllAnnotatedListeners(anno?: any, eventName?: string): IEventEmitter

Implementation of IEventEmitter.removeAllAnnotatedListeners
- Defined in iron-beam.ts:366
Parameters
- Optional anno: any
- Optional eventName: string
Returns IEventEmitter

removeAllListeners

removeAllListeners(eventName?: string): IEventEmitter

Implementation of IEventEmitter.removeAllListeners
- Defined in iron-beam.ts:355
Parameters
- Optional eventName: string
Returns IEventEmitter

removeAnnotatedListeners

removeAnnotatedListeners(eventName: string, anno?: any): IEventEmitter

Implementation of IEventEmitter.removeAnnotatedListeners
- Defined in iron-beam.ts:351
Parameters
- eventName: string
- Optional anno: any
Returns IEventEmitter

removeListener

removeListener(eventName: string, method: Function): IEventEmitter

Implementation of IEventEmitter.removeListener
- Defined in iron-beam.ts:339
Parameters
- eventName: string
- method: Function
Returns IEventEmitter

setMaxListeners

setMaxListeners(max: number): EventEmitter

Implementation of IEventEmitter.setMaxListeners
- Defined in iron-beam.ts:144
´setMaxListeners´ sets the current max listeners.

Parameters
- max: number
  
  ´max´ is a number of the max listeners before throwing warnings.
Returns EventEmitter

Returns EventEmitter for chaining.

Static listenerCount

listenerCount(emitter: EventEmitter, eventName: string): number

- Defined in iron-beam.ts:419
Parameters
- emitter: EventEmitter
- eventName: string
Returns number

Generated using TypeDoc