Skip to main content

ModuleOverrides

type ModuleOverrides = {
[method: string]: ((...args: any[]) => any) | undefined;
  getCapabilities?: () => Promise<Record<string, unknown>>;
  log?: (message: LogMessage | string, logLevel: keyof typeof LogLevels) => Promise<void>;
  unload?: () => Promise<void>;
};

Optional method overrides the host can supply to customise the module scripting object beyond the defaults.

Typed keys shadow the corresponding GuestModule methods. The index signature allows adding host-specific methods that the guest can discover through the scripting object protocol.

Overrides are applied via Object.assign so they become own enumerable properties on the instance — required for SSF's _toJSON discovery (for…in enumeration).

Indexable​

[method: string]: ((...args: any[]) => any) | undefined

Properties​

getCapabilities?​

optional getCapabilities?: () => Promise<Record<string, unknown>>;

Returns​

Promise<Record<string, unknown>>

log?​

optional log?: (message: LogMessage | string, logLevel: keyof typeof LogLevels) => Promise<void>;

Parameters​

message​

LogMessage | string

logLevel​

keyof typeof LogLevels

Returns​

Promise<void>

unload?​

optional unload?: () => Promise<void>;

Returns​

Promise<void>