Toolkit

Appearance

Documentation / @andrew_l/app / WorkerInstance

Interface: WorkerInstance<C> ​

Runtime state of a worker instance. Extends AppInstance with task queue and pool. Managed with the standard startApp / stopApp / shutdownApp lifecycle.

Type Parameters ​

C ​

C extends WorkerStrategy = WorkerStrategy

Properties ​

definition ​

definition: WorkerDefinition<{ }, { }, { }, C>

isIdle ​

readonly isIdle: boolean

Returns true when worker do nothing

isOverloaded ​

readonly isOverloaded: boolean

Check if the worker is overloaded (e.g., queue length is high)

log ​

log: Logger

overloadedSignaled ​

overloadedSignaled: boolean

pool ​

pool: ResourcePool<symbol>

queue ​

queue: AsyncIterableQueue<TaskContext<C>>

queueMaxSize ​

readonly queueMaxSize: number

queueSize ​

readonly queueSize: number

Tasks queue size

runTask ​

runTask: null | CancellablePromise<void>

taskParallel ​

readonly taskParallel: number

Methods ​

addTask() ​

addTask(ctx): void

Add task into execution queue

Parameters ​

ctx ​

TaskContext<C>

Returns ​

void