Type Alias CompanionActionDefinition<TSchema>

CompanionActionDefinition: TSchema extends CompanionActionSchemaWithResult<
    infer Options,
    infer Result,
>
    ? CompanionActionDefinitionBase<Options> & (
        | CompanionActionDefinitionSubscribeHooks<Options>
        | CompanionActionDefinitionNoSubscribeHooks
    ) & CompanionActionDefinitionCallbackWithResult<Options, Result>
    : TSchema extends CompanionActionSchemaWithoutResult<infer Options>
        ? CompanionActionDefinitionBase<Options> & (
            | CompanionActionDefinitionSubscribeHooks<Options>
            | CompanionActionDefinitionNoSubscribeHooks
        ) & CompanionActionDefinitionCallbackWithoutResult<Options>
        : never

The definition of an action consists of the intersection of these fields:

CompanionActionDefinitionBase: fields common to all actions
CompanionActionDefinitionCallbackWithResult or CompanionActionDefinitionCallbackNoResult: fields defining the function to implement the action (and optionally return a result)
CompanionActionDefinitionSubscribeHooks or CompanionActionDefinitionNoSubscribeHooks: fields to optionally define subscribe/unsubscribe functionality

Type Parameters

TSchema extends
    | CompanionActionSchemaWithoutResult<CompanionOptionValues>
    | CompanionActionSchemaWithResult<CompanionOptionValues, JsonValue> =
    | CompanionActionSchemaWithoutResult<CompanionOptionValues>
    | CompanionActionSchemaWithResult<CompanionOptionValues, JsonValue>