Type Alias Intent<Tag, Fields>

An intent is an abstract description of an operation to be performed. Intents allow actions to be performed across plugins.

type Intent<Tag extends string, Fields extends IntentParams> = {
    _schema: IntentSchema<Tag, Fields>;
    data: IntentData<Fields>;
    id: Tag;
    undo?: boolean;
}

Type Parameters

Tag extends string
Fields extends IntentParams

Index

Properties

_schema data id undo?

Properties

_schema

_schema: IntentSchema<Tag, Fields>

data

data: IntentData<Fields>

Any data needed to perform the desired action.

id

id: Tag

The id of the intent.

`Optional`undo

undo?: boolean

Whether or not the intent is being undone.