Class Queue

constructor

• new Queue(
      client: ModalClient,
      queueId: string,
      name?: string,
      ephemeralHbManager?: EphemeralHeartbeatManager,
  ): Queue
  Internal

  Parameters

  • client: ModalClient
  • queueId: string
  • Optionalname: string
  • OptionalephemeralHbManager: EphemeralHeartbeatManager

  Returns Queue

Optional Readonlyname

ReadonlyqueueId

clear

• clear(params?: QueueClearParams): Promise<void>

  Parameters

  • params: QueueClearParams = {}

    オプションパラメータ

  Returns Promise<void>

  Description

  Queue パーティションからすべてのオブジェクトを削除する

closeEphemeral

• closeEphemeral(): void

  Returns void

  Description

  一時的な Queue を削除する。一時的な Queue でのみ使用可能

get

• get(params?: QueueGetParams): Promise<unknown>

  Parameters

  • params: QueueGetParams = {}

    オプションパラメータ

  Returns Promise<unknown>

  Queue から取り出したオブジェクト

  Description

  Queue から次のオブジェクトを取り出して返す。デフォルトではアイテムが存在するまで待機する

  Throws

  timeoutMs 設定時、タイムアウト内にアイテムがなければ QueueEmptyError

getMany

• getMany(n: number, params?: QueueGetParams): Promise<unknown[]>

  Parameters

  • n: number

    取得する最大アイテム数

  • params: QueueGetParams = {}

    オプションパラメータ

  Returns Promise<unknown[]>

  取り出したオブジェクトの配列

  Description

  Queue から最大 n 個のオブジェクトを取り出して返す。デフォルトではアイテムが存在するまで待機する

  Throws

  timeoutMs 設定時、タイムアウト内にアイテムがなければ QueueEmptyError

iterate

• iterate(params?: QueueIterateParams): AsyncGenerator<unknown, void, unknown>

  Parameters

  • params: QueueIterateParams = {}

    オプションパラメータ

  Returns AsyncGenerator<unknown, void, unknown>

  Description

  Queue 内のアイテムを変更せずにイテレートする

len

• len(params?: QueueLenParams): Promise<number>

  Parameters

  • params: QueueLenParams = {}

    オプションパラメータ

  Returns Promise<number>

  オブジェクト数

  Description

  Queue 内のオブジェクト数を返す

put

• put(v: unknown, params?: QueuePutParams): Promise<void>

  Parameters

  • v: unknown

    追加するアイテム

  • params: QueuePutParams = {}

    オプションパラメータ

  Returns Promise<void>

  Description

  Queue の末尾にアイテムを追加する。満杯の場合は指数バックオフでリトライする

  Throws

  タイムアウト後も満杯の場合 QueueFullError

putMany

• putMany(values: unknown[], params?: QueuePutParams): Promise<void>

  Parameters

  • values: unknown[]

    追加するアイテムの配列

  • params: QueuePutParams = {}

    オプションパラメータ

  Returns Promise<void>

  Description

  Queue の末尾に複数のアイテムを追加する。満杯の場合は指数バックオフでリトライする

  Throws

  タイムアウト後も満杯の場合 QueueFullError

Staticdelete

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

  Parameters

  • name: string
  • options: QueueDeleteParams = {}

  Returns Promise<void>

  Deprecated

  Use client.queues.delete() instead.

Staticephemeral

• ephemeral(params?: QueueEphemeralParams): Promise<Queue>

  Parameters

  • params: QueueEphemeralParams = {}

  Returns Promise<Queue>

  Deprecated

  Use client.queues.ephemeral() instead.

Staticlookup

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

  Parameters

  • name: string
  • options: QueueFromNameParams = {}

  Returns Promise<Queue>

  Deprecated

  Use client.queues.fromName() instead.