Interface ModuleManifestRuntime

Information on how to execute the module

interface ModuleManifestRuntime {
    api: "nodejs-ipc";
    apiVersion: string;
    entrypoint: string;
    permissions?: {
        "child-process"?: boolean;
        filesystem?: boolean;
        "native-addons"?: boolean;
        "worker-threads"?: boolean;
    };
    type: "node18"
    | "node22";
}

Properties

api apiVersion entrypoint permissions? type

Properties

api

api: "nodejs-ipc"

Which host-api does it use. In the future alternate options will be allowed

apiVersion

apiVersion: string

The version of the host-api used

entrypoint

entrypoint: string

Entrypoint to pass to the runtime. eg index.js

Optionalpermissions

permissions?: {
    "child-process"?: boolean;
    filesystem?: boolean;
    "native-addons"?: boolean;
    "worker-threads"?: boolean;
}

Permissions required by the module. This is used to inform the user of the permissions required by the module. Note: this requires the node22 or newer runtime

Type declaration

  • Optionalchild-process?: boolean

    Enable if the module uses child processes

  • Optionalfilesystem?: boolean

    Enable if the module requires read/write access to the filesystem

  • Optionalnative-addons?: boolean

    Enable if the module uses native addons

  • Optionalworker-threads?: boolean

    Enable if the module uses worker threads

type

type: "node18" | "node22"

Type of the module. Must be: node18 or node22

Settings

Member Visibility

On This Page

Properties