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:68

Methods

delete

delete(name: string, params?: QueueDeleteParams): Promise<void>
Parameters
- name: string
  削除する Queue の名前
- params: QueueDeleteParams = {}
  オプションパラメータ
Returns Promise<void>
Description
名前付き Queue を削除する。削除は不可逆で、現在使用中の App にも影響する
- Defined in src/queue.ts:135

ephemeral

ephemeral(params?: QueueEphemeralParams): Promise<Queue>
Parameters
- params: QueueEphemeralParams = {}
  オプションパラメータ
Returns Promise<Queue>
一時的な Queue インスタンス

Description
名前のない一時的な Queue を作成する。削除するには Queue.closeEphemeral() を呼び出す必要がある
- Defined in src/queue.ts:77

fromName

fromName(name: string, params?: QueueFromNameParams): Promise<Queue>
Parameters
- name: string
  Queue の名前
- params: QueueFromNameParams = {}
  オプションパラメータ
Returns Promise<Queue>
Queue インスタンス

Description
名前で Queue を参照する
- Defined in src/queue.ts:102