Class QueueService

Service for managing Queues.

Normally only ever accessed via the client as:

const modal = new ModalClient();
const queue = await modal.queues.fromName("my-queue");

Index

Constructors

Methods

delete ephemeral fromName

Constructors

constructor

new QueueService(client: ModalClient): QueueService
Parameters
- client: ModalClient
Returns QueueService
- Defined in src/queue.ts:43

Methods

delete

delete(name: string, params?: QueueDeleteParams): Promise<void>
Delete a Queue by name.
Parameters
- name: string
- params: QueueDeleteParams = {}
Returns Promise<void>
- Defined in src/queue.ts:84

ephemeral

ephemeral(params?: QueueEphemeralParams): Promise<Queue>
Create a nameless, temporary Queue. You will need to call Queue.closeEphemeral() to delete the Queue.
Parameters
- params: QueueEphemeralParams = {}
Returns Promise<Queue>
- Defined in src/queue.ts:51

fromName

fromName(name: string, params?: QueueFromNameParams): Promise<Queue>
Reference a Queue by name.
Parameters
- name: string
- params: QueueFromNameParams = {}
Returns Promise<Queue>
- Defined in src/queue.ts:67