API reference / @chanx-js/client / core

core

The framework-agnostic runtime: client, connections, topics and the wire protocol.

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