@camunda8/sdk
    Preparing search index...

    Type Alias StreamState

    StreamState:
        | { status: "open" }
        | { attempt: number; cause: StreamFailure; status: "reconnecting" }
        | { reason: StreamClosedReason; status: "closed" }

    The observable state of a stream handle.

    Type Declaration

    • { status: "open" }

      The stream is established.

    • { attempt: number; cause: StreamFailure; status: "reconnecting" }

      The stream is down and a re-open attempt is scheduled or in flight.

      • Readonlyattempt: number

        Consecutive failed streams or open attempts, starting at 1.

      • Readonlycause: StreamFailure
      • Readonlystatus: "reconnecting"
    • { reason: StreamClosedReason; status: "closed" }

      Terminal: the stream is down and will not be re-opened.