IRequestHandle

Interface of object returned by a request initiation function.

Extends

Methods

  • setUpdateHandler

    • setUpdateHandler(streamId: number, updateHandler: IUpdateHandler): boolean

      Set a new update handler for a particular stream.

      Parameters

      • streamId: number from a [[Record]] or [[Update]].
      • updateHandler: IUpdateHandler new function to invoke for future updates.

      Returns boolean

      Boolean indicating whether the `streamId` was valid.
  • setConflationParameters

    • setConflationParameters(conflationParameters?: IConflationParameters): Promise<Error>

      Update conflation for all streams from this request.

      Parameters

      Returns Promise<Error>

  • [Symbol.asyncIterator]

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

      Returns AsyncIterator<IImage>

  • 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