Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/natsws/src/mod.ts>ServerInfo

WebSocket NATS
nats-io/nats.ws
Go to Latest
interface ServerInfo
import { type ServerInfo } from "https://deno.land/x/natsws@v1.28.0/src/mod.ts";

ServerInfo represents information from the connected server

Properties

optional
auth_required: boolean

True if the server requires authentication

client_id: number

Server-assigned client_id

optional
client_ip: string

The client's IP as seen by the server

optional
cluster: string

The name or ID of the cluster

optional
connect_urls: string[]

Other servers available on the connected cluster

optional
git_commit: string

Git commit information on the built server binary

go: string

Version information on the Go stack used to build the server binary

optional
headers: boolean

True if the server supports headers

host: string

Hostname of the connected server

optional
jetstream: boolean

True if the server supports JetStream

optional
ldm: boolean

True if the server is in Lame Duck Mode

max_payload: number

Max number of bytes in message that can be sent to the server

optional
nonce: string

If the server required nkey or JWT authentication the nonce used during authentication.

port: number

The port where the server is listening

proto: number

Version number of the NATS protocol

server_id: string

The ID of the server

server_name: string

The name of the server

optional
tls_available: boolean

True if TLS is available

optional
tls_required: boolean

True if TLS connections are required

optional
tls_verify: boolean

True if TLS client certificate verification is required

version: string

The nats-server version