re-frame/docs/API.md

The re-frame API

Orientation:

1. The re-frame API is provided by the re-frame.core 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)

Links To API docs

The core API is:

• dispatch, dispatch-sync. See also this FAQ
• reg-event-db, reg-event-fx
• reg-sub
• subscribe

Occasionally, you'll need to use:

• reg-fx XXX
• reg-cofx XXX and inject-cofx

And, finally, there are builtin Interceptors which are used a bit:

• path
• after
• debug
• and browse the others

Builtin effects: XXX

Builtin coeffects: XXX

Previous: First Code Walk-Through       Up: Index       Next: Mental Model Omnibus