IIterableResponse<T, U>

Async iterable response.
T is the response type (set of records).
U us the record type.

T can === U when a response is a single record.

Extends

Extended by

Methods

  • [Symbol.asyncIterator]

    • [Symbol.asyncIterator](): AsyncIterator<U>

      Returns AsyncIterator<U>

  • delete

    • delete(): void

      Delete the request. For subscription requests, it is up to the user to call this when they wish to unsubscribe. For non-subscription requests, this happens automatically once all the responses have been iterated (or the for-await loop is broken out of without completion), so there is no need to explicitly call this method though it can be used mid-request to cancel it.

      Returns void

Properties

Also in this Section

Functions

Interfaces