re-frame/docs/API.md

The re-frame API

A starting summary, in note form:

1. the re-frame API is provided by the core.cljs namespace
2. That namespace is fairly small, with only 5 to 10 functions in regular use.
3. That namespace has occasional comments. You should read it from top to bottom.
4. All often-used API functions have doc strings, linked-to below. (But there's currently no auto-generated API docs because of this problem)

Links To API docs

The core API is these functions:

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

Occasionally, you'll also need to use:

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

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

• path
• after
• debug
• and the rest are in the same namespace

Builtin effects: XXX

Builtin coeffects: XXX

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