Cmd overview

Defines Cmds as streams of asynchronous operations which can not fail and that can optionally carry a message.

See the Platform.Cmd Elm package.

Added in v0.5.0

Table of contents

• Applicative
  • of
• Functor
  • map
• constructors
  • none
• model
  • Cmd (interface)
• utils
  • batch

Applicative

of

Creates a new Cmd that carries the provided Msg.

Signature

export declare function of<Msg>(m: Msg): Cmd<Msg>

Added in v0.5.0

Functor

map

Maps the carried Msg of a Cmd into another Msg.

Signature

export declare function map<A, Msg>(f: (a: A) => Msg): (cmd: Cmd<A>) => Cmd<Msg>

Added in v0.5.0

constructors

none

A none command is an empty stream.

Signature

export declare const none: Cmd<never>

Added in v0.5.0

model

Cmd (interface)

Signature

export interface Cmd<Msg> extends Observable<Task<Option<Msg>>> {}

Added in v0.5.0

utils

batch

Batches the execution of a list of commands.

Signature

export declare function batch<Msg>(arr: Array<Cmd<Msg>>): Cmd<Msg>

Added in v0.5.0