SnapshotHandle

Extends

• StreamHandle<SnapshotResult>

Methods

• setCallbackHandler

  • setCallbackHandler(handler?: ISnapshotHandler): void

    Set a callback handler.

    Parameters

    • handler?: ISnapshotHandlerthe callback handler

    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<SnapshotResult, any>>

    Advance iterator to next partial response.

    Returns Promise<IteratorResult<SnapshotResult, any>>

• [asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<SnapshotResult>

    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<SnapshotResult>

Properties

• handler?: ISnapshotHandler