API Docs for: 0.0.1
Show:

EventEmitter Class

Defined in: lib/events.js:27
Module: niviz

Any object can mix-in or inherit from the EventEmitter prototype.

Constructor

EventEmitter

()

Defined in lib/events.js:27

Example:

var inherits = niviz.util.inherits; var EventEmitter = niviz.EventEmitter;

function MyEventEmitter() { EventEmitter.call(this); }

inherits(MyEventEmitter, EventEmitter);

Item Index

Methods

Properties

Methods

emit

() Boolean

Defined in lib/events.js:138

Fires event type, executing all registered handlers synchronously.

Returns:

Boolean:

True if there were listeners; false otherwise;

listeners

() Array

Defined in lib/events.js:173

Returns all listeners for the given event type.

Returns:

Array:

All listeners for type.

nodeback

(
  • callback
)
private chainable

Defined in lib/events.js:183

Registers a callback function to be called by the end or error events, like a Node callback would be called.

Parameters:

  • callback Function

    The callback to register.

off

(
  • [type]
  • [listener]
)
chainable

Defined in lib/events.js:96

Removes a given event listener. If no listener is given, removes all listeners for the given type; if no type is given, removes all listeners.

Parameters:

  • [type] String optional

    The event type.

  • [listener] Function optional

    The listener.

on

(
  • type
  • listener
)
chainable

Defined in lib/events.js:53

Registers a new handler for an event.

Parameters:

once

(
  • type
  • listener
)
chainable

Defined in lib/events.js:70

Registers a new handler for an event that will be executed at most once.

Parameters:

Properties

events

Object private

Defined in lib/events.js:45