createQueue API

API reference for the createQueue composable.

Explore these related pages for additional context and usage patterns.

Page	Category
createQueue	Registration
createRegistry	Registration
createTimeline	Registration

Functions

createQueue

(_options?: QueueOptions) => QueueContext<QueueTicketInput<unknown>, QueueTicket<QueueTicketInput<unknown>>>

Creates a new queue instance

createQueueContext

(_options?: QueueContextOptions) => ContextTrinity<QueueContext<QueueTicketInput<unknown>, QueueTicket<QueueTicketInput<unknown>>>>

Creates a new queue context.

useQueue

(namespace?: string) => QueueContext<QueueTicketInput<unknown>, QueueTicket<QueueTicketInput<unknown>>>

Returns the current queue instance.

Options

events

boolean | undefined

Enable event emission for registry operations

Default: false

reactive

boolean | undefined

Enable reactive behavior for registry operations

Default: false

timeout

number | undefined

Default timeout in milliseconds for tickets without explicit timeout

Default: 3000

Properties

collection

ReadonlyMap<ID, E>

The collection of tickets in the registry

size

number

The number of tickets in the registry

Methods

clear

() => void

Clear the entire registry

has

(id: ID) => boolean

Check if a ticket exists by ID

keys

() => readonly ID[]

Get all registered IDs

browse

(value: E["value"]) => ID[] | undefined

Browse for an ID(s) by value

lookup

(index: number) => ID | undefined

lookup a ticket by index number

get

(id: ID) => E | undefined

Get a ticket by ID

upsert

(id: ID, ticket?: Partial<Z>, event?: string) => E

Update or insert a ticket by ID

values

() => readonly E[]

Get all values of registered tickets

entries

() => readonly [ID, E][]

Get all entries of registered tickets

reindex

() => void

Reset the index directory and update all tickets

move

(id: ID, toIndex: number) => E | undefined

Seek for a ticket based on direction and optional predicate

seek

(direction?: "first" | "last", from?: number, predicate?: (ticket) => boolean) => E | undefined

on

<K extends Extensible<RegistryEventName>>(event: K, cb: EventHandler<E, K>) => void

Listen for registry events

off

<K extends Extensible<RegistryEventName>>(event: K, cb: EventHandler<E, K>) => void

Stop listening for registry events

emit

<K extends Extensible<RegistryEventName>>(event: K, data: EventPayload<E, K>) => void

Emit an event with data

dispose

() => void

Clears the registry and removes all listeners

onboard

(registrations: Partial<Z & RegistryTicket>[]) => E[]

Onboard multiple tickets at once

batch

<R>(fn: () => R) => R

Execute operations in a batch, deferring cache invalidation and event emission until complete

register

(ticket?: Partial<Z>) => E

unregister

(id?: ID) => E | undefined

Unregister a ticket from the queue

pause

() => E | undefined

Pause the timeout of the first ticket in the queue

resume

() => E | undefined

Resume the timeout of the first paused ticket in the queue

offboard

(ids: ID[]) => void

Batch unregister tickets from the queue