modal-ts
    Preparing search index...

    Class Queue

    Distributed, FIFO queue for data flow in Modal Apps.

    Index

    Constructors

    • Internal

      Parameters

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

      Returns Queue

    Properties

    name?: string
    queueId: string

    Methods

    • Parameters

      Returns Promise<void>

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

    • Returns void

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

    • Parameters

      Returns Promise<unknown>

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

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

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

    • Parameters

      • n: number

        取得する最大アイテム数

      • params: QueueGetParams = {}

        オプションパラメータ

      Returns Promise<unknown[]>

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

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

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

    • Parameters

      Returns AsyncGenerator<unknown, void, unknown>

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

    • Parameters

      Returns Promise<number>

      オブジェクト数

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

    • Parameters

      • v: unknown

        追加するアイテム

      • params: QueuePutParams = {}

        オプションパラメータ

      Returns Promise<void>

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

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

    • Parameters

      • values: unknown[]

        追加するアイテムの配列

      • params: QueuePutParams = {}

        オプションパラメータ

      Returns Promise<void>

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

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