40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
## The re-frame API
|
|
|
|
Orientation:
|
|
1. The re-frame API is provided by the [re-frame.core](/src/re_frame/core.cljc) namespace
|
|
2. Typically, you'll only use 4 to 10 of the API functions (small surface)
|
|
3. Oft-used API functions have doc strings, linked-to below (no auto-generated docs [because of this problem](/src/re_frame/core.cljc#L23-L36))
|
|
|
|
## Links To API docs
|
|
|
|
The core API is:
|
|
- [dispatch](/src/re_frame/router.cljc#L229-L239), [dispatch-sync](/src/re_frame/router.cljc#L247-L259). See also [this FAQ](/docs/FAQs/When-Does-Dispatch-Happen.md)
|
|
- [reg-event-db](/src/re_frame/core.cljc#L71-L80), [reg-event-fx](/src/re_frame/core.cljc#L87-L97)
|
|
- [reg-sub](/src/re_frame/subs.cljc#L151-L237)
|
|
- [subscribe](/src/re_frame/subs.cljc#L67-L83)
|
|
|
|
Occasionally, you'll need to use:
|
|
- [reg-fx]() XXX
|
|
- [reg-cofx]() XXX and [inject-cofx](/src/re_frame/cofx.cljc#L22-L73)
|
|
|
|
And, finally, there are builtin Interceptors which are used a bit:
|
|
- [path](/src/re_frame/std_interceptors.cljc#L149-L173)
|
|
- [after](/src/re_frame/std_interceptors.cljc#L260-L281)
|
|
- [debug](/src/re_frame/std_interceptors.cljc#L13-L36)
|
|
- [and browse the others](/src/re_frame/std_interceptors.cljc)
|
|
|
|
Builtin effects:
|
|
XXX
|
|
|
|
Builtin coeffects:
|
|
XXX
|
|
|
|
Previous: [First Code Walk-Through](CodeWalkthrough.md)
|
|
Up: [Index](README.md)
|
|
Next: [Mental Model Omnibus](MentalModelOmnibus.md)
|
|
|
|
|
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|