status-im/re-frame
2
0
Fork 0
mirror of https://github.com/status-im/re-frame.git synced 2025-02-24 07:48:14 +00:00
Code Issues Projects Releases Wiki Activity

Improvements is dispatch documentation, ahead of an API release

Browse Source
This commit is contained in:
Mike Thompson 2017-07-20 18:21:14 +10:00
parent 8c7ec7976c
commit c0534e0839
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/re_frame/router.cljc
View File

@ -227,14 +227,16 @@
;; ;;
(defn dispatch (defn dispatch
"Queue the given event for processing by the registered event handler. "Enqueue `event` for processing by event handling machinery.
Just to be clear: the event handler is not run immediately - it is not run `event` is a vector of length >= 1. The 1st element identifies the kind of event.
Note: the event handler is not run immediately - it is not run
synchronously. It will likely be run 'very soon', although it may be synchronously. It will likely be run 'very soon', although it may be
added to the end of a FIFO queue which already contain events. added to the end of a FIFO queue which already contain events.
Usage: Usage:
(dispatch [:delete-item 42])" (dispatch [:order-pizza {:supreme 2 :meatlovers 1 :veg 1})"
[event] [event]
(if (nil? event) (if (nil? event)
(throw (ex-info "re-frame: you called \"dispatch\" without an event vector." {})) (throw (ex-info "re-frame: you called \"dispatch\" without an event vector." {}))
@ -243,13 +245,18 @@
(defn dispatch-sync (defn dispatch-sync
"Sychronously (immediately!) process the given event using the registered handler. "Synchronously (immediately) process `event`. Do not queue.
Generally, you shouldn't use this - you should use `dispatch` instead. It Generally, don't use this. Instead use `dispatch`. It is an error
is an error to use `dispatch-sync` within an event handler. to use `dispatch-sync` within an event handler.
Useful when any delay in processing is a problem:
1. the `:on-change` handler of a text field where we are expecting fast typing.
2 when initialising your app - see 'main' in todomvc examples
3. in a unit test where we don't want the action 'later'
Usage: Usage:
(dispatch-sync [:delete-item 42])" (dispatch-sync [:sing :falsetto 634])"
[event-v] [event-v]
(handle event-v) (handle event-v)
(-call-post-event-callbacks event-queue event-v) ;; slightly ugly hack. Run the registered post event callbacks. (-call-post-event-callbacks event-queue event-v) ;; slightly ugly hack. Run the registered post event callbacks.