Skip to content
delta-base docs

Command

API reference for Command

@delta-base/toolkit

Type Alias: Command<CommandType, CommandData, CommandMetadata>

Section titled “Type Alias: Command<CommandType, CommandData, CommandMetadata>”

Command<CommandType, CommandData, CommandMetadata> = Readonly<CommandMetadata extends undefined ? object : object> & object

Command type for representing intent to perform actions

Type declaration

Section titled “Type declaration”

kind?

Section titled “kind?”

readonly optional kind: "Command"

Type Parameters

Section titled “Type Parameters”

CommandType

Section titled “CommandType”

CommandType extends string = string

The command type identifier

CommandData

Section titled “CommandData”

CommandData extends DefaultRecord = DefaultRecord

The command payload data type

CommandMetadata

Section titled “CommandMetadata”

CommandMetadata extends DefaultRecord | undefined = undefined

Optional metadata type