Interface WorkerNodeOptions

interface WorkerNodeOptions {
    args?: any;
    blob?: boolean;
    directory?: string;
    imports?: string[];
    methods?: WorkerMethod[];
    name?: string;
    optimizedPull?: boolean;
    poolConcurrency?: number;
    poolSize?: number;
    services?: Service[];
    timeout?: number;
    type?: "classic" | "typescript" | "module";
    uid?: string;
    worker?: string;
}

Hierarchy (view full)

Properties

args? blob? directory? imports? methods? name? optimizedPull? poolConcurrency? poolSize? services? timeout? type? uid? worker?

Properties

Optional args

args?: any

Optional blob

blob?: boolean

Optional directory

directory?: string

Optional imports

imports?: string[]

Worker external imports

Optional methods

methods?: WorkerMethod[]

Optional name

name?: string

User friendly name of the node Used for querying a node by its name.

Optional optimizedPull

optimizedPull?: boolean

Pull requests skip the worker

Optional poolConcurrency

poolConcurrency?: number

Concurrent tasks send to the same worker in the pool

Optional poolSize

poolSize?: number

Pool size, defaults to 4 but should equal the amount of available cores - 1

Optional services

services?: Service[]

Services to clone from main thread. When not specified it will clone all services

Default

model.findAllServices()

Optional timeout

timeout?: number

Timeout spawning

Optional type

type?: "classic" | "typescript" | "module"

Worker type

Optional uid

uid?: string

Manually set the unique identifier of the node

Optional worker

worker?: string

Worker runner file. When running in the browser, this is the js file named worker.openhps-core.min.js

Settings

Member Visibility

Theme

On This Page

argsblobdirectoryimportsmethodsnameoptimizedPullpoolConcurrencypoolSizeservicestimeouttypeuidworker