Class: Observable

saij/core/Observable~Observable


import Observable from 'saij/core/Observable';

Abstract base class; normally only used for creating subclasses and not instantiated in apps. An event target providing convenient methods for listener registration and unregistration. A generic change event is always available through module:saij/core/Observable~Observable#changed.

new Observable()

src/saij/core/Observable.js, line 22
Fires:

Methods

changed()

src/saij/core/Observable.js, line 39

Increases the revision counter and dispatches a 'change' event.

getRevision(){number}

src/saij/core/Observable.js, line 50

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener){module:saij/core/utils/events~EventsKey|Array.<module:saij/core/utils/events~EventsKey>}

src/saij/core/Observable.js, line 63

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:saij/core/utils/events~EventsKey|Array.<module:saij/core/utils/events~EventsKey>}

src/saij/core/Observable.js, line 85

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

un(type, listener)

src/saij/core/Observable.js, line 104

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.