Skip to content

Main Navigation Guide Server Client

Appearance

Sidebar Navigation

API reference

@chanx-js/client

core

Classes

ChannelConnection

ChanxRequestError

TopicHandle

Interfaces

ChannelController

ChannelDescriptor

ChannelSnapshot

ChanxClient

ChanxErrorFrame

ChanxMessage

ClientOptions

ConnectOptions

ControllerOptions

Envelope

HeartbeatOptions

MessageStream

RequestOptions

SocketOptions

StreamOptions

SubscribeOptions

TopicController

TopicDescriptor

TopicRef

TopicRequestOptions

TopicsController

TopicsControllerOptions

TopicSnapshot

TopicsSnapshot

ValidateConfig

Validators

WebSocketLike

Type Aliases

ActionHandler

AddressOf

BufferMode

ExtractParams

HandlerMap

NoReplies

ParamsOf

PatternOf

RawFrame

RepliesOf

ReplyOf

RequestFn

SocketFactory

SocketStatus

ToClientOf

TopicControllerOptions

TopicMap

TopicMessage

TopicParamsArgs

TopicRefOf

TopicsOf

ToServerOf

Validator

Variables

COMPLETE_ACTIONS

ENVELOPE_FIELDS

ENVELOPE_VERSION

ERROR_ACTION

SUBSCRIPTION_ACTIONS

Functions

createChannelController

createClient

createTopicController

createTopicsController

defineChannel

defineTopic

formatPattern

isFrameworkAction

stripEnvelope

terminateAllSockets

withEnvelope

react

Interfaces

UseChannelResult

UseTopicResult

UseTopicsResult

Type Aliases

UseChannelOptions

UseTopicOptions

UseTopicsOptions

Variables

ChanxClientProvider

Functions

setDefaultClient

useChannel

useChanxClient

useTopic

useTopics

solid

Interfaces

ChannelResult

TopicResult

TopicsResult

Functions

createChannel

createTopic

createTopics

getChanxClient

setDefaultClient

svelte

Interfaces

ChannelStore

TopicsStore

TopicStore

Functions

createChannel

createTopic

createTopics

getChanxClient

setDefaultClient

vue

Interfaces

UseChannelResult

UseTopicResult

UseTopicsResult

Variables

chanxPlugin

Functions

setDefaultClient

useChannel

useChanxClient

useTopic

useTopics

@chanx-js/codegen

Interfaces

AsyncAPIDocument

ChannelEmitOptions

ChannelInfo

ChannelObject

ConnectionInfo

GenerateOptions

GenerateResult

JsonSchema

OperationObject

Reply

ReuseOptions

ReuseResolution

Functions

analyze

camelCase

declareType

emitChannels

emitChannelsDeclaration

emitSchemas

emitZod

emitZodDeclaration

generate

loadSchema

pascalCase

renderImports

renderReexports

resolveReuse

tsType

@chanx-js/layers

core

Classes

InMemoryChannelLayer

Interfaces

ChannelLayer

LayerChannel

LayerOptions

Type Aliases

ChannelMessage

MessageHandler

redis

Classes

InvalidToken

RedisPubSubChannelLayer

Interfaces

RedisPubSubChannelLayerOptions

RedisSentinelHost

Type Aliases

RedisHost

SerializerFormat

@chanx-js/nestjs

Classes

ChanxModule

ChanxService

Interfaces

ChanxModuleOptions

ChanxTopicOptions

Type Aliases

ChanxConsumerOptions

ChanxModuleAsyncOptions

Functions

asyncapiOf

ChanxConsumer

ChanxTopic

Ctx

dtoSchema

On

OnEvent

Payload

@chanx-js/server

core

Classes

AsyncJsonWebsocketConsumer

AuthenticationError

Topic

Interfaces

AcceptedUpgrade

AnyMessageDefinition

AsyncAPIChannel

AsyncAPIDocsAssets

AsyncAPIDocument

AsyncAPIExternalDocs

AsyncAPIInfo

AsyncAPIOperation

AsyncAPIOptions

AsyncAPISecurityScheme

AsyncAPIServeOptions

AsyncAPIServer

AsyncAPITag

AuthenticationPayload

BroadcastOptions

Chanx

ChanxOptions

Connection

ConnectRequest

ConsumerBuilder

ConsumerOptions

ConsumerSource

Context

Credential

ErrorHooks

HandlerMethodInfo

HandlerOptions

HandlerSet

HandlerSetBuilder

Logger

Message

MessageDefinition

MessageOptions

PublishOptions

RefusedUpgrade

Session

StandardSchemaV1

Subscription

TopicBuilder

TopicContext

TopicOptions

TopicSource

Transport

UpgradeRequest

ValidationIssue

WebSocketBinding

Type Aliases

AsyncAPIHandler

BinaryFrame

ClassConsumerOptions

ClassContext

ConsumerLike

EventsOf

JsonSchema

MessageOf

PathParams

TopicClassContext

TopicLike

Variables

AuthenticationMessage

CompleteMessage

ErrorMessage

EventCompleteMessage

GroupCompleteMessage

PingMessage

PongMessage

Functions

asyncapiHandler

consumer

Consumer

createChanx

defineMessage

defineMessages

handlerMethods

handlers

On

OnEvent

topic

topicConsumer

crossws

Functions

chanxHooks

fastify

Type Aliases

FastifyChanxOptions

Functions

chanxFastify

hono

Functions

chanxHono

node

Interfaces

Attachment

SocketOptions

Type Aliases

AttachOptions

Functions

asyncapiMiddleware

attachChanx

testing

Interfaces

Capture

CapturedBroadcastEvent

CapturedTopicBroadcast

TestClient

WaitOptions

Type Aliases

Frame

Functions

captureBroadcastEvents

captureTopicBroadcasts

connect

On this page

API reference

Packages

@chanx-js/client
@chanx-js/codegen
@chanx-js/layers
@chanx-js/nestjs
@chanx-js/server

Pager

Next page@chanx-js/client

MIT licensed