Class WorkerOptions

constructor

• new WorkerOptions(options): WorkerOptions

• Parameters

  • options: {
        agent: string;
        agentName?: string;
        apiKey?: string;
        apiSecret?: string;
        host?: string;
        initializeProcessTimeout?: number;
        jobMemoryLimitMB?: number;
        jobMemoryWarnMB?: number;
        loadFunc?: ((worker) => Promise<number>);
        loadThreshold?: number;
        logLevel?: string;
        maxRetry?: number;
        numIdleProcesses?: number;
        permissions?: WorkerPermissions;
        port?: number;
        production?: boolean;
        requestFunc?: ((job) => Promise<void>);
        shutdownProcessTimeout?: number;
        workerToken?: string;
        workerType?: JobType;
        wsURL?: string;
    }

    Worker options

    • agent: string

      Path to a file that has Agent as a default export, dynamically imported later for entrypoint and prewarm functions

    • Optional agentName?: string

    • Optional apiKey?: string

    • Optional apiSecret?: string

    • Optional host?: string

    • Optional initializeProcessTimeout?: number

    • Optional jobMemoryLimitMB?: number

    • Optional jobMemoryWarnMB?: number

    • Optional loadFunc?: ((worker) => Promise<number>)

      Called to determine the current load of the worker. Should return a value between 0 and 1.

      • • (worker): Promise<number>

        • Parameters

          • worker: Worker

          Returns Promise<number>

    • Optional loadThreshold?: number

      When the load exceeds this threshold, the worker will be marked as unavailable.

    • Optional logLevel?: string

    • Optional maxRetry?: number

    • Optional numIdleProcesses?: number

    • Optional permissions?: WorkerPermissions

    • Optional port?: number

    • Optional production?: boolean

    • Optional requestFunc?: ((job) => Promise<void>)

      • • (job): Promise<void>

        • Parameters

          • job: JobRequest

          Returns Promise<void>

    • Optional shutdownProcessTimeout?: number

    • Optional workerToken?: string

    • Optional workerType?: JobType

    • Optional wsURL?: string

  Returns WorkerOptions

agent

agentName

Optional apiKey

Optional apiSecret

host

initializeProcessTimeout

jobMemoryLimitMB

jobMemoryWarnMB

loadFunc

loadThreshold

logLevel

maxRetry

numIdleProcesses

permissions

port

production

requestFunc

shutdownProcessTimeout

Optional workerToken

workerType

wsURL