status-im
/
re-frame-10x
mirror of https://github.com/status-im/re-frame-10x.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update InterEpoch.md

This commit is contained in:
Mike Thompson 2018-02-10 14:59:05 +11:00 committed by GitHub
parent 86965f8e62
commit 32470d0324
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/HyperlinkedInformation/InterEpoch.md
View File

@ -2,15 +2,14 @@
> "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.
`re-frame-trace` is built around the idea of epochs. An epoch captures all of the traces emitted by re-frame during the 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:
Inter-epoch traces are emitted under (at least) three 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
* When views have local ratoms, used, for example, to handle the appearance of popups or mouseover annimations. When the state of these ratoms change, views will likely rerender, and the trace to do with this rerendering will flow from reagent to `re-frame`trace`. But there'll be no "current" epoch to put it in. Because there was no event.
* A Figwheel recompile and subsequent code reload will cause all existing subscriptions to be destroyed, andwill trigger a complete re-render of your application
* `re-frame-trace` itself resetting the value in `app-db`. Again there will be a flurry of subscription and view trace, but no epoch, because there was no event.
The first two of these are essential to your application, the latter two are incidental to the tooling.
The first of these is essential to the functioning of your application, whidh makes their trace interesting and informative. The last two are incidental to the tooling and are probably best ignored. Probably.
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".
`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".