moonbit-community/rabbita/cmd

README
U
Cmd
U
Dispatch
U
Html
- ::mountApp::mount
- ::with_initApp::with_init
- ::with_routeApp::with_route
- ::viewCell::view
V
attempt
V
batch
V
cell
V
cell_with_dispatch
V
delay
V
effect
V
new
V
none
V
perform
V
render_to_string
V
simple_cell
V
simple_cell_with_dispatch
V
static_cell

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

Cmd

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.

Cmd::to_array

source

fn Cmd::to_array(self : Cmd) -> Array[@moonbit-community/rabbita/internal/interface.CustomCommand
CustomCommand]

Dispatch

source

pub(all) type Dispatch[Msg] (Msg) -> Cmd

Dispatch::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn[Msg] Dispatch::inner(self : Dispatch[Msg]) -> ((Msg) -> Cmd)

Convert newtype to its underlying type, automatically derived.

Dispatch::map

source

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

EffectKind

source

pub(all) enum EffectKind {
  Immediately
  AfterRender
}

Scheduler

source

type Scheduler

Scheduler::add

source

fn Scheduler::add(self : Scheduler, cmd : Cmd) -> Unit

Scheduler::add_url_changed

source

fn Scheduler::add_url_changed(self : Scheduler, url : @moonbit-community/rabbita/url.Url
Url) -> Unit

after_render

source

let after_render : EffectKind

attempt

source

fn[A, E : Error] attempt(msg : (Result[A, E]) -> Cmd, f : async () -> A raise E) -> Cmd

Create a command that runs an async function and handles errors.

Similar to perform, but captures errors and passes Result[A, E] to msg.

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))
}

delay

source

fn delay(cmd : Cmd, ms : Int) -> Cmd

Delay execution of a command by ms milliseconds.

The delayed command is added back to the message queue after the timer fires.

effect

source

fn effect(f : async () -> Unit noraise) -> Cmd

Create a command that runs an effectful async function

immediately

source

let immediately : EffectKind

none

source

let none : Cmd

A command that does nothing.

perform

source

fn[A] perform(msg : (A) -> Cmd, f : async () -> A noraise) -> Cmd

Create a command that runs an async function.

The async function f is executed, then its result is converted into a new command by msg and scheduled back into the update loop.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Cmd

#Cmd::to_array

#Dispatch

#Dispatch::inner

#Dispatch::map

#EffectKind

#Scheduler

#Scheduler::add

#Scheduler::add_url_changed

#after_render

#attempt

#batch

#custom_cmd

#delay

#effect

#immediately

#none

#perform

Source Files

Cmd

Cmd::to_array

Dispatch

Dispatch::inner

Dispatch::map

EffectKind

Scheduler

Scheduler::add

Scheduler::add_url_changed

after_render

attempt

batch

custom_cmd

delay

effect

immediately

none

perform