Service | /src/mod.ts | natsws@v1.28.0

Module

x/natsws/src/mod.ts>Service

WebSocket NATS

nats-io/nats.ws

Go to Latest

mod.ts (default module)

JetStreamAccountStats

JetStreamApiStats

JetStreamClient

JetStreamManager

JetStreamManagerOptions

JetStreamOptions

JetStreamPublishOptions

JetStreamUsageAccountLimits

Msg

Sub

SubjectTransformConfig

TypedSubscriptionOptions

UserPass

Views

AbortOnMissingResource

IngestionFilterFnResult

JetStreamPullSubscription

JetStreamSubscription

JetStreamSubscriptionOptions

ObjectStoreMetaOptions

ObjectStoreOptions

ObjectStorePutOpts

ObjectStoreStatus

OrderedConsumerOptions

StreamInfoRequestOptions

ServiceErrorCodeHeader

ServiceErrorHeader

backoff

buildAuthenticator

canonicalMIMEHeaderKey

usernamePasswordAuthenticator

Msg

Sub

TypedSubscriptionOptions

IngestionFilterFnResult

ServiceErrorCodeHeader

canonicalMIMEHeaderKey

checkOptions

checkUnsupportedOption

extractProtocolMessage

usernamePasswordAuthenticator

interface Service

implements ServiceGroup

import { type Service } from "https://deno.land/x/natsws@v1.28.0/src/mod.ts";

Properties

stopped: Promise<null | Error>

A promise that gets resolved to null or Error once the service ends. If an error, then service exited because of an error.

isStopped: boolean

True if the service is stopped

Methods

stats(): Promise<ServiceStats>

Returns the stats for the service.

info(): ServiceInfo

Returns a service info for the service

ping(): ServiceIdentity

Returns the identity used by this service

reset(): void

Resets all the stats

stop(err?: Error): Promise<null | Error>

Stop the service returning a promise once the service completes. If the service was stopped due to an error, that promise resolves to the specified error