QueryHandle

An Async Iterable query stream. Each entry will be a QueryResult that may or may not contain a QueryMessage.

Extends

Methods

  • setCallbackHandler

    • setCallbackHandler(handler?: IQueryHandler): void

      Set a callback handler.

      Parameters

      Returns void

  • delete

    • delete(): void

      Delete the handle. This will close the stream and dispose of the resources used by it.

      Returns void

  • isDeleted

    • isDeleted(): boolean

      Has the handle been deleted?

      Returns boolean

  • next

    • next(): Promise<IteratorResult<QueryResult, any>>

      Advance iterator to next partial response.

      Returns Promise<IteratorResult<QueryResult, any>>

  • [asyncIterator]

    • [asyncIterator](): AsyncIterableIterator<T>

      A stream handle object that will iterate through Stream Messages. If a StatusCode is returned then this will indicate the cause of an error that may be recoverable. If this stream recovers the api will handle the recovery automatically.

      Returns AsyncIterableIterator<T>

Properties

Also in this Section