Watcher
It allows you to observe a STORE.
You can intercept when the STORE performs an action
or a mutator
.
addWatch
Inserts a WATCHER into JON
addWatch( watcher:Watcher )
removeWatch
Removes a listener from JON
if actionName
is null
delete all listener of STORE
if callback
is null
delete all listener of actionName
removeWatch( watcher:Watcher )
Watcher
Identifies a callback
called when a specific STORE action/mutator
is executed
interface Watcher {
store: Store,
actionName: string,
callback: WatchCallback,
}
- store
STORE instance to be observed - actionName
name of the 'action' or 'mutator' to be observed - callback
Function executed when 'action' or 'mutator' are called(msg: WatchMsg) => void
WatchMsg
Data of an event that occurred in a STORE.
interface WatchMsg {
type: EVENTS_TYPES,
store: Store,
key: string,
payload: any,
result: any,
subcall: boolean
}
- type
Type of event, may be:mutator
,action
- store
STORE instance that generated this event - key
Name of theaction
ormutator
that generated this event - payload
Parameters sent to theaction
ormutator
- result
Value returned byaction
- subcall
true
if it is a call from anotheraction