Interface InstanceTypes

The generic type arguments for the module instance. This is optional, but allows you to have better type safety in various places

interface InstanceTypes {
    actions: Record<
        string,
        | CompanionActionSchemaWithoutResult<CompanionOptionValues>
        | CompanionActionSchemaWithResult<CompanionOptionValues, JsonValue>,
    >;
    compositeElements?: Record<
        string,
        CompanionCompositeElementSchema<CompanionOptionValues>,
    >;
    config: JsonObject;
    feedbacks: Record<string, CompanionFeedbackSchema<CompanionOptionValues>>;
    secrets: JsonObject | undefined;
    variables: CompanionVariableValues;
}

Index

Properties

actions compositeElements? config feedbacks secrets variables

Properties

actions

actions: Record<
    string,
    | CompanionActionSchemaWithoutResult<CompanionOptionValues>
    | CompanionActionSchemaWithResult<CompanionOptionValues, JsonValue>,
>

`Optional`compositeElements

compositeElements?: Record<
string,
CompanionCompositeElementSchema<CompanionOptionValues>,
>

config

config: JsonObject

feedbacks

feedbacks: Record<string, CompanionFeedbackSchema<CompanionOptionValues>>

secrets

secrets: JsonObject | undefined

variables

variables: CompanionVariableValues