Class Queue

A running batch queue: binds queue identity to a FanOut. Driving it (pump each tick) is the consumer's job unless it was started via SpawnClient.startQueue, which registers it on the monitor loop.

Index

Constructors

Properties

fanOut id name order size

Accessors

isComplete summary

Methods

Constructors

constructor

new Queue(built: BuiltQueue, fanOut: FanOut): Queue
Parameters
- built: BuiltQueue
- fanOut: FanOut
Returns Queue
- Defined in core/queue.ts:233

Properties

`Readonly`fanOut

fanOut: FanOut

`Readonly`id

id: string

`Readonly`name

name: string

`Readonly`order

order: string[]

`Readonly`size

size: number

Accessors

isComplete

get isComplete(): boolean
Returns boolean
- Defined in core/queue.ts:258

summary

get summary(): FanOutSummary
Returns FanOutSummary
- Defined in core/queue.ts:255

Methods

pump

pump(nowMs: number): Promise<boolean>
Parameters
- nowMs: number
Returns Promise<boolean>
- Defined in core/queue.ts:251

`Static`create

create(client: SpawnClient, cfg: QueueConfig, opts?: QueueOptions): Queue
Build from a config and wire up a fresh FanOut over the given client.
Parameters
- client: SpawnClient
- cfg: QueueConfig
- opts: QueueOptions = {}
Returns Queue
- Defined in core/queue.ts:241