Class Queue

ReadonlyqueueId

clear

• clear(options?: QueueClearOptions): Promise<void>

  Remove all objects from a queue partition.

  Parameters

  • options: QueueClearOptions = {}

  Returns Promise<void>

closeEphemeral

• closeEphemeral(): void

  Delete the ephemeral queue. Only usable with Queue.ephemeral().

  Returns void

get

• get(options?: QueueGetOptions): Promise<any>

  Remove and return the next object from the queue.

  By default, this will wait until at least one item is present in the queue. If timeout is set, raises QueueEmptyError if no items are available within that timeout in milliseconds.

  Parameters

  • options: QueueGetOptions = {}

  Returns Promise<any>

getMany

• getMany(n: number, options?: QueueGetOptions): Promise<any[]>

  Remove and return up to n objects from the queue.

  By default, this will wait until at least one item is present in the queue. If timeout is set, raises QueueEmptyError if no items are available within that timeout in milliseconds.

  Parameters

  • n: number
  • options: QueueGetOptions = {}

  Returns Promise<any[]>

iterate

• iterate(options?: QueueIterateOptions): AsyncGenerator<any, void, unknown>

  Iterate through items in a queue without mutation.

  Parameters

  • options: QueueIterateOptions = {}

  Returns AsyncGenerator<any, void, unknown>

len

• len(options?: QueueLenOptions): Promise<number>

  Return the number of objects in the queue.

  Parameters

  • options: QueueLenOptions = {}

  Returns Promise<number>

put

• put(v: any, options?: QueuePutOptions): Promise<void>

  Add an item to the end of the queue.

  If the queue is full, this will retry with exponential backoff until the provided timeout is reached, or indefinitely if timeout is not set. Raises QueueFullError if the queue is still full after the timeout.

  Parameters

  • v: any
  • options: QueuePutOptions = {}

  Returns Promise<void>

putMany

• putMany(values: any[], options?: QueuePutOptions): Promise<void>

  Add several items to the end of the queue.

  If the queue is full, this will retry with exponential backoff until the provided timeout is reached, or indefinitely if timeout is not set. Raises QueueFullError if the queue is still full after the timeout.

  Parameters

  • values: any[]
  • options: QueuePutOptions = {}

  Returns Promise<void>

Staticdelete

• delete(name: string, options?: DeleteOptions): Promise<void>

  Delete a queue by name.

  Parameters

  • name: string
  • options: DeleteOptions = {}

  Returns Promise<void>

Staticephemeral

• ephemeral(options?: EphemeralOptions): Promise<Queue>

  Create a nameless, temporary queue. You will need to call closeEphemeral() to delete the queue.

  Parameters

  • options: EphemeralOptions = {}

  Returns Promise<Queue>

Staticlookup

• lookup(name: string, options?: LookupOptions): Promise<Queue>

  Lookup a queue by name.

  Parameters

  • name: string
  • options: LookupOptions = {}

  Returns Promise<Queue>