Type Alias CompanionActionDefinitionCallbackWithResult<TOptions, TResult>

The definition of an action that returns a result must opt into returning a result by specifying hasResult: true.

type CompanionActionDefinitionCallbackWithResult<
    TOptions extends CompanionOptionValues,
    TResult extends JsonValue,
> = {
    callback: (
        action: CompanionActionEvent<TOptions>,
        context: CompanionActionCallbackContext,
    ) => Promise<TResult> | TResult;
    hasResult: true;
}

Type Parameters

TOptions extends CompanionOptionValues
TResult extends JsonValue

Index

Properties

callback hasResult

Properties

callback

callback: (
action: CompanionActionEvent<TOptions>,
context: CompanionActionCallbackContext,
) => Promise<TResult> | TResult

A function called when the callback executes, potentially returning a result value.

hasResult

hasResult: true