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

    Function validateManifest

    • Validate that a manifest looks correctly populated.

      Parameters

      • manifest: unknown

        the manifest to validate

      • looseChecks: boolean

        when true, skip the checks that reject leftover module template placeholder values. Used while a module is still being developed.

      Returns asserts manifest is {
          $schema?: string;
          bonjourQueries?: Record<
              string,
              | {
                  addressFamily?: "ipv4"
                  | "ipv6"
                  | "ipv4+6";
                  port?: number;
                  protocol: "tcp" | "udp";
                  txt?: Record<string, string>;
                  type: string;
              }
              | {
                  addressFamily?: "ipv4"
                  | "ipv6"
                  | "ipv4+6";
                  port?: number;
                  protocol: "tcp" | "udp";
                  txt?: Record<string, string>;
                  type: string;
              }[],
          >;
          bugs: string;
          description: string;
          id: string;
          isPrerelease?: boolean;
          keywords: string[];
          legacyIds: string[];
          license: string;
          maintainers: {
              email?: string;
              github?: string;
              name: string;
              url?: string;
          }[];
          manufacturer: string;
          name: string;
          products: string[];
          repository: string;
          runtime: {
              api: "nodejs-ipc";
              apiVersion: string;
              entrypoint: string;
              permissions?: {
                  "child-process"?: boolean;
                  filesystem?: boolean;
                  "insecure-algorithms"?: boolean;
                  "native-addons"?: boolean;
                  "worker-threads"?: boolean;
              };
              type: "node22"
              | "node26";
          };
          shortname: string;
          type: "connection";
          version: string;
      }