Interface CompanionActionSchemaWithResult<TOptions, TResult>

An action whose callback returns a result must specify the result type.

interface CompanionActionSchemaWithResult<
    TOptions extends CompanionOptionValues,
    TResult extends JsonValue,
> {
    options: TOptions;
    result: TResult;
}

Type Parameters

TOptions extends CompanionOptionValues
TResult extends JsonValue

Hierarchy (View Summary)

CompanionActionSchemaOptions<TOptions>
- CompanionActionSchemaWithResult

Index

Properties

Properties

options

options: TOptions

The types of the action's options.

result

result: TResult

The action callback returns a value of this type (possibly behind a promise).