Interface WorkerOptions

interface WorkerOptions {
    argv?: any[];
    env?: Dict<string> | typeof SHARE_ENV;
    eval?: boolean;
    workerData?: any;
    stdin?: boolean;
    stdout?: boolean;
    stderr?: boolean;
    execArgv?: string[];
    resourceLimits?: ResourceLimits;
    transferList?: TransferListItem[];
    trackUnmanagedFds?: boolean;
    name?: string;
}

Properties

argv? env? eval? workerData? stdin? stdout? stderr? execArgv? resourceLimits? transferList? trackUnmanagedFds? name?

Properties

Optionalargv

argv?: any[]

List of arguments which would be stringified and appended to process.argv in the worker. This is mostly similar to the workerData but the values will be available on the global process.argv as if they were passed as CLI options to the script.

Optionalenv

env?: Dict<string> | typeof SHARE_ENV

Optionaleval

eval?: boolean

OptionalworkerData

workerData?: any

Optionalstdin

stdin?: boolean

Optionalstdout

stdout?: boolean

Optionalstderr

stderr?: boolean

OptionalexecArgv

execArgv?: string[]

OptionalresourceLimits

resourceLimits?: ResourceLimits

OptionaltransferList

transferList?: TransferListItem[]

Additional data to send in the first worker message.

OptionaltrackUnmanagedFds

trackUnmanagedFds?: boolean

Default

true

Optionalname

name?: string

An optional name to be appended to the worker title for debuggin/identification purposes, making the final title as [worker ${id}] ${name}.

Settings

Member Visibility

On This Page

Properties