Class BufferedEventEmitter

constructor

• new BufferedEventEmitter(options?): BufferedEventEmitter

• Parameters

  • options: BufferedEventEmitterOptions = {}

  Returns BufferedEventEmitter

Static CLEAN_BUFFER_EVENT_NAME

Static FLUSH_BUFFER_EVENT_NAME

bufferExists

• bufferExists(id): boolean

• Checks if the buffer exists

  Parameters

  • id: string | number

  Returns boolean

cleanBuffer

• cleanBuffer(bufferId): BufferedEventEmitter

• Remove all data from the buffer. Just the global clean buffer event will be emitted

  Parameters

  • bufferId: string | number

  Returns BufferedEventEmitter

createBuffer

• createBuffer(bufferId, context?): BufferedEventEmitter

• Creates a named buffer

  Parameters

  • bufferId: string | number

  • context: any = {}

  Returns BufferedEventEmitter

emit

• emit(eventName, ...args): BufferedEventEmitter

• Trigger an event. Will send all arguments after eventName to the existent event listeners

  Parameters

  • eventName: string

    Event's name

  • Rest ...args: any[]

  Returns BufferedEventEmitter

  Member Of

  EventManager

emitBuffered

• emitBuffered(bufferId, eventName, message): BufferedEventEmitter

• Add and event to the buffer. Will store the event until the buffer is flushed

  Parameters

  • bufferId: string | number

  • eventName: string

  • message: any

  Returns BufferedEventEmitter

flush

• flush(bufferId): BufferedEventEmitter

• Flushes the buffer, calling the registered handlers for all events Maintenance will try to remove it after a few moments.

  Parameters

  • bufferId: string | number

  Returns BufferedEventEmitter

getBuffer

• getBuffer(id): BufferedEventEmitterBuffer

• Parameters

  • id: string | number

  Returns BufferedEventEmitterBuffer

setDebugMode

• setDebugMode(value): BufferedEventEmitter

• Enable/disable debug mode (console.log everywhere ;))

  Parameters

  • value: boolean

  Returns BufferedEventEmitter

subscribe

• subscribe(eventName, fn): Function

• Add an event listener

  Parameters

  • eventName: string

  • fn: Function

  Returns Function

  the "unsubscriber". Call this function to unsubscribe this event (or use the unsubscribe method)

subscribeMultiple

• subscribeMultiple(eventNames, fn): Function

• Parameters

  • eventNames: string[]

    Event's names

  • fn: Function

    Handler

  Returns Function

  Unsubscriber for all events

  See

  • subscribe Add an event listener to multiple event aht the same time
  • EventManager.subscribe

unsubscribe

• unsubscribe(eventName, fn): BufferedEventEmitter

• Removes an event listener from an event

  Parameters

  • eventName: string

    Event's name

  • fn: Function

    Handler to remove

  Returns BufferedEventEmitter

unsubscribeAll

• unsubscribeAll(eventNames): BufferedEventEmitter

• Removes all event listeners from the given events

  Parameters

  • eventNames: string[]

  Returns BufferedEventEmitter

unsubscribeMultiple

• unsubscribeMultiple(eventNames, fn): BufferedEventEmitter

• Parameters

  • eventNames: string[]

  • fn: Function

  Returns BufferedEventEmitter

  See

  unsubscribe Removes the event listener from multiple events