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

    Interface CompanionPresetDefinitionBase<TType>

    interface CompanionPresetDefinitionBase<TType extends string> {
        keywords?: string[];
        name: string;
        notes?: string;
        type: TType;
    }

    Type Parameters

    • TType extends string

    Hierarchy (View Summary)

    Index
    keywords? name notes? type
    keywords?: string[]

    Keywords for the preset This is extra search terms to allow users to find the right preset

    name: string

    A name for this preset This is typically shown as a tooltip

    notes?: string

    The notes for this preset, this will be copied to the button This can be used to describe the purpose of the button, or to provide additional setup information to the user

    type: TType

    The type of the preset

    Settings
    Member Visibility

    On This Page
    Properties