@companion-module/base
    Preparing search index...

    Interface CompanionActionCallbackContext

    Utility functions available while an action is being executed

    interface CompanionActionCallbackContext {
        signal: AbortSignal;
        type: "action" | "feedback";
        setCustomVariableValue(
            variableName: string,
            value: CompanionVariableValue,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    signal type

    Methods

    setCustomVariableValue

    Properties

    signal: AbortSignal

    A signal that aborts when the result of this execution is no longer needed (eg the user aborted the running actions). Respecting it is optional; if you do, stop work and throw - the thrown error will be ignored.

    type: "action" | "feedback"

    Whether this context is for an action or feedback

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods