GitHub package.json versionTypeScriptNPM
GitHub package.json versionTypeScriptNPM
Latest

API

cache

is a property providing access to the underlying immutable cache managed by this Eagle Eye instance.

closed

is a boolean property confirming that an Eagle Eye instance is still active.
Use the "closing" event to be notified right before an Eagle Eye instance deactivation.
Please see the dispose method below.

createEagleEye

is a function accepting three optional parameters (to wit: the initial state object or an AutoImmutable instance bearing this initial state object, the prehooks and the storage) and returning an Eagle Eye instance.
The Eagle Eye state manager's store is directly accessible through its store api.

dispose

is a method of the Eagle Eye state manager instance for deactivating this instance.
A deactivated Eagle Eye state manager is permanently closed.
The state manager's closed property confirms this status.

store

Please visit global store for detail.

stream

is a property of the Eagle Eye state manager instance which returns a change stream channels.
It accepts an optional selector map parameter; and returns a change stream channel.
A change in any of the referenced state slices within a stream automatically triggers an update of the related channel.data property and a subsequent notification of the subscribers of a particular channel.