Interface: TaskQueueSettings<Type, Data, Options>
Settings for a TaskQueue.
Type parameters​
| Name | Type |
|---|---|
Type | string |
Data | unknown |
Options | unknown |
Properties​
autoActivate​
• Optional autoActivate: boolean
A flag indicating whether activation should happen as part of
instantiation. Set to false to override the default true behavior. When
autoActivate === false, no tasks reified from the queue's bucket will be
automatically processed as part of queue instantiation, regardless of the
autoProcess setting. Invoke queue.activate() as a separate step to
finish activation and start processing tasks.
Defined in​
packages/@orbit/core/src/task-queue.ts:42
autoProcess​
• Optional autoProcess: boolean
A flag indicating whether tasks should be processed as soon as they are
pushed into a queue. Set to false to override the default true
behavior.
Defined in​
packages/@orbit/core/src/task-queue.ts:32
bucket​
• Optional bucket: Bucket<Task<Type, Data, Options>[]>
A bucket in which to persist queue state.
Defined in​
packages/@orbit/core/src/task-queue.ts:25
name​
• Optional name: string
Name used for tracking and debugging a task queue.