Header menu logo Mibo

Cmd<'Msg> Type

Represents a command that produces side effects in the Elmish runtime.

Commands are returned from init and update functions to schedule side effects that run outside the pure update cycle. They can dispatch messages back into the runtime, either immediately or deferred.

Union cases

Union case Description

Batch batch

Full Usage: Batch batch

Parameters:

Multiple effects to execute in this frame

batch : Effect<'Msg>[]

DeferNextFrame batch

Full Usage: DeferNextFrame batch

Parameters:

Effects deferred until the next frame begins

batch : Effect<'Msg>[]

Empty

Full Usage: Empty

No-op command (use )

Msg msg

Full Usage: Msg msg

Parameters:
    msg : 'Msg

A message to dispatch directly without wrapping in an effect

msg : 'Msg

NowAndDeferNextFrame(now, next)

Full Usage: NowAndDeferNextFrame(now, next)

Parameters:

Combination of immediate and deferred effects

now : Effect<'Msg>[]
next : Effect<'Msg>[]

Quit

Full Usage: Quit

Signals the runtime to exit after this frame

Single single

Full Usage: Single single

Parameters:

Single effect to execute

single : Effect<'Msg>

Instance members

Instance member Description

this.IsBatch

Full Usage: this.IsBatch

Returns: bool
Returns: bool

this.IsDeferNextFrame

Full Usage: this.IsDeferNextFrame

Returns: bool
Returns: bool

this.IsEmpty

Full Usage: this.IsEmpty

Returns: bool
Returns: bool

this.IsMsg

Full Usage: this.IsMsg

Returns: bool
Returns: bool

this.IsNowAndDeferNextFrame

Full Usage: this.IsNowAndDeferNextFrame

Returns: bool
Returns: bool

this.IsQuit

Full Usage: this.IsQuit

Returns: bool
Returns: bool

this.IsSingle

Full Usage: this.IsSingle

Returns: bool
Returns: bool

Type something to start searching.