Add inter-epoch subscription docs

This commit is contained in:
Daniel Compton 2018-02-09 21:36:18 +13:00
parent f0ef165b21
commit 4d394a3de6
2 changed files with 21 additions and 1 deletions

View File

@ -0,0 +1,16 @@
# Inter Epoch Traces
> "Music is the space between the notes." - Claude Debussy
re-frame-trace is built around the idea of epochs. An epoch captures all of the traces that are emitted by re-frame after handling an event. But what about the traces that are emitted when re-frame *isn't* handling an event? These are the inter-epoch traces.
Inter-epoch traces are emitted under (at least) four circumstances:
* Mouse hover state causing subscriptions to run/re-run
* Click/input events sent to local ratoms (rather than as events to app-db)
* Figwheel disposing old subscriptions and re-rendering your application
* Resetting app-db in re-frame-trace
The first two of these are essential to your application, the latter two are incidental to the tooling.
re-frame-trace collects any inter-epoch subscription traces and shows them in the subs panel with the next epoch. They are broken out into a separate section marked: "Inter-Epoch Subscriptions".

View File

@ -299,7 +299,11 @@
:style {:margin "19px 0px"}]
^{:key "inter-epoch-title"}
[:h2 {:class "bm-heading-text"
:style {:margin "19px 0px"}} "Inter-Epoch Subscriptions"]
:style {:margin "19px 0px"}}
[rc/link
{:href "https://github.com/Day8/re-frame-trace/blob/master/docs/HyperlinkedInformation/InterEpoch.md"
:label "Inter-Epoch Subscriptions"}]]
(for [p inter-epoch-subs]
^{:key (:id p)}
[pod (merge p (get sub-expansions (:id p)))])))