Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
interface StreamInfo
implements ApiPaged
import { type StreamInfo } from "https://deno.land/x/natsws@v1.28.0/src/mod.ts";

Stream configuration info

Properties

config: StreamConfig

The active configuration for the Stream

created: string

The ISO Timestamp when the stream was created

Detail about the current State of the Stream

optional
cluster: ClusterInfo

Cluster information for the stream if applicable

optional
mirror: StreamSourceInfo

Information about an upstream stream source in a mirror

optional
sources: StreamSourceInfo[]

Sources for the Stream if applicable

optional
alternates: StreamAlternate[]

Alternates for a stream if applicable. Alternates are listed in order of TTL. With streams at the start of the Array potentially closer and faster to access.

optional
ts: string

The ISO timestamp when the StreamInfo was generated. This field is only available on servers 2.10.x or better