ish.js API Doc (alpha)

The emitter factory

ish.emitter()

Description:

A basic emitter factory.

Returns
emitter

An instance of the $.emitter

Methods

emit(type, argsObject)

line 11
Description:

Emit an action or data to subcribers.

Returns
$.emitter

Chainable.

Parameters:
Name Type Description
type String

The name of the emission.
argsObject Object

An Object of data to be passed with the emission.

flush()

line 52
Description:

Remove all subscribers from the emitter instance.

Returns
$.emitter

Chainable.

subscribe(type, fn)

line 27
Description:

Subcribe from an a specific emission.

Returns
$.emitter

Chainable.

Parameters:
Name Type Description
type String

The name of the emission type you are subscribing.
fn function

The function that you are subscribing.

unsubscribe(type, fn)

line 39
Description:

Unsubcribe from an a specific emission.

Returns
$.emitter

Chainable.

Parameters:
Name Type Description
type String

The name of the emission type you are unsubscribing.
fn function

The function that you are unsubscribing.