Documentation - v1.2.0-alpha.3
    Preparing search index...

    A helper class for streaming responses to the client.

    This class is used to send a series of updates to the client in a single response. The expected sequence of calls is:

    queueInformativeUpdate(), queueTextChunk(), queueTextChunk(), ..., endStream().

    Once endStream() is called, the stream is considered ended and no further updates can be sent.

    Index

    Constructors

    Accessors

    Methods

    • Queues a chunk of partial message text to be sent to the client

      Parameters

      • text: string

        Partial text of the message to send.

      • Optionalcitations: Citation[]

        Citations to be included in the message.

      Returns void

      The text we be sent as quickly as possible to the client. Chunks may be combined before delivery to the client.