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

    Interface ModuleManifest

    This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

    interface ModuleManifest {
        $schema?: string;
        bonjourQueries?: { [k: string]: ModuleBonjourQuery | ModuleBonjourQuery[] };
        bugs: string;
        description: string;
        id: string;
        isPrerelease?: boolean;
        keywords: string[];
        legacyIds: string[];
        license: string;
        maintainers: ModuleManifestMaintainer[];
        manufacturer: string;
        name: string;
        products: [string, ...string[]];
        repository: string;
        runtime: ModuleManifestRuntime;
        shortname: string;
        version: string;
    }
    Index

    Properties

    $schema? bonjourQueries? bugs description id isPrerelease? keywords legacyIds license maintainers manufacturer name products repository runtime shortname version

    Properties

    $schema?: string
    bonjourQueries?: { [k: string]: ModuleBonjourQuery | ModuleBonjourQuery[] }

    If the device or software for your module supports bonjour announcements, Companion will offer an easy way to watch for these announcements. Each query you define must have a matching config field of type 'bonjour-device' with the same name

    Type Declaration

    bugs: string

    URL to bug tracker

    description: string

    Description of the module

    id: string

    Unique identifier for the module

    isPrerelease?: boolean

    Is this a pre-release version

    keywords: string[]
    legacyIds: string[]

    If the module had a different unique identifier previously, then specify it here

    license: string

    SPDX identifier for license of the module

    maintainers: ModuleManifestMaintainer[]

    List of active maintiners

    manufacturer: string
    name: string

    Name of the module

    products: [string, ...string[]]

    1

    repository: string

    URL to the source repository

    runtime: ModuleManifestRuntime
    shortname: string
    version: string

    Current version of the module

    Settings

    Member Visibility

    On This Page

    Properties