re-frame/docs/API.md

The re-frame API

So, I have some good news and some bad news.

First, the bad news:

1. These API docs are not auto-generated because of this problem
2. There's no added nudity

Now, the good news:

1. the re-frame API is entirely provided by the core namespace
2. That namespace has occasional comments. You should read it sometime.
3. Each API function has passable documentation which is linked-to below.

Links To API docs

The core API is these functions:

• dispatch, dispatch-sync. See also this FAQ
• reg-event-db, reg-event-fx are both documented in the code namespace
• reg-sub
• subscribe

Occasionally, you'll need to use:

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

And, finally, there are some builtin Interceptors:

• path
• after
• debug

Builtin effects: XXX

Builtin coeffects: XXX

Previous: XXX       Up: Index       Next: XXX