Skip to content

Main Navigation Guide Frameworks API Design

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

ParamsOf

PatternOf

RawFrame

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

ReuseOptions

ReuseResolution

Functions

analyze

camelCase

declareType

emitChannels

emitChannelsDeclaration

emitSchemas

emitZod

emitZodDeclaration

generate

loadSchema

pascalCase

renderImports

renderReexports

resolveReuse

tsType

On this page

API reference

Packages

@chanx-js/client
@chanx-js/codegen

Pager

Next page@chanx-js/client

MIT licensed