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

    Interface CompanionLearnCallbackContext

    Utility functions available in the context of an action/feedback

    interface CompanionLearnCallbackContext {
        signal: AbortSignal;
        type: "action" | "feedback";
    }

    Hierarchy (View Summary)

    Index

    Properties

    Properties

    signal: AbortSignal

    A signal that will abort if the user cancels the learn process. Once the signal is aborted, the learn process should be stopped as soon as possible, with the return value or any thrown error being ignored.

    type: "action" | "feedback"

    Whether this context is for an action or feedback