moonbit-community/rabbita/cmd

README
U
Cell
U
Cmd
U
Emit
U
Enumerate
U
Html
- ::assocVal::assoc
- ::assoc_byVal::assoc_by
- ::constantVal::constant
- ::enumerateVal::enumerate
- ::enumerate_byVal::enumerate_by
- ::mapVal::map
- ::map2Val::map2
- ::map3Val::map3
- ::map4Val::map4
- ::map5Val::map5
- ::map6Val::map6
- ::map7Val::map7
- ::map8Val::map8
- ::map9Val::map9
- ::switchVal::switch
- ::switch_byVal::switch_by
- ::viewVal::view
- ::view2Val::view2
- ::view3Val::view3
- ::view4Val::view4
- ::view5Val::view5
- ::view6Val::view6
- ::view7Val::view7
- ::view8Val::view8
- ::view9Val::view9
V
batch
V
cell
V
cell_with_emit
V
none
V
render_to_string
V
simple_cell
V
simple_cell_with_emit
V
static_cell

moonbit-community/rabbita/cmd does not have a README file

Hook

type Hook[Arg] = (&Scheduler, Arg) -> Unit

Scheduler

source

pub(open) trait Scheduler {
  fn run_effect(Self, EffectKind, (&Scheduler) -> Unit) -> Unit
  fn queue_message(Self, @moonbit-community/rabbita/internal/slotmap.Id
Id, @moonbit-community/rabbita/internal/any.Any
Any) -> Unit
  fn drain_message(Self) -> Unit
  fn add(Self, Cmd) -> Unit = _
  fn hooks(Self) -> Hooks
}

Cmd

source

type Cmd

A deferred command handled by the Rabbita runtime.

Cmd models side effects in the update loop. Commands are returned from update or embedded in Html event handlers, and are executed later by the runtime.

EffectKind

source

pub(all) enum EffectKind {
  Immediately
  AfterRender
}

Emit

source

#alias(Dispatch, deprecated="Use Emit[Msg] instead.")
pub(all) struct Emit[Msg]((Msg) -> Cmd)

Emit::map

source

fn[A, B] Emit::map(self : Emit[A], f : (B) -> A) -> Emit[B]

Hooks

source

pub(all) struct Hooks {
  url_request : (&Scheduler, String) -> Unit?
  url_changed : (&Scheduler, String) -> Unit?
}

Path

source

pub(all) enum Path {
  Index(Int, Path)
  Keyed(String, Path)
  Root
} derive(Compare, Eq, Hash)

A position in an indexed or keyed runtime tree.

after_render

source

let after_render : EffectKind

batch

source

fn batch(cmds : Array[Cmd]) -> Cmd

Combine multiple commands into one command.

custom_cmd

source

#alias(raw_effect, deprecated="`raw_effect` is deprecated, use `custom_cmd` instead")
fn custom_cmd(callback : (&Scheduler) -> Unit, kind? : EffectKind) -> Cmd

Create a low-level effect command for runtime and FFI integration. Consider use higher-level helpers like perform, delay, @http.post(), and @dialog.show() in app code.

This function allows you to write wrappers that encapsulate FFI in a command when the functionality is not provided by Rabbita yet.

Parameters:

callback: receives the runtime Scheduler, so it can enqueue follow-up commands (for example, after an async callback).
kind: determines when the effect runs.
- Immediately: run as soon as the runtime receives it.
- AfterRender: run after DOM patching for the current flush completes.

Example:

extern "js" fn set_timeout(f : () -> Unit, ms : Int) = "(f,ms) => setTimeout(f, ms)"

pub fn delay(cmd : Cmd, ms : Int) -> Cmd {
  raw_effect(scheduler => set_timeout(() => scheduler.add(cmd), ms))
}