Documentation / zerotal / client / Channel
Class: Channel
Defined in: packages/client/src/Socket.ts:104
A subscribed channel. Bind broadcast events with Channel.listen.
Extended by
Constructors
Constructor
new Channel(
name,_socket):Channel
Defined in: packages/client/src/Socket.ts:112
Parameters
name
string
The wire channel name (already prefixed, e.g. private-orders.42).
_socket
Returns
Channel
Properties
name
readonlyname:string
Defined in: packages/client/src/Socket.ts:114
The wire channel name (already prefixed, e.g. private-orders.42).
_socket
protectedreadonly_socket:Socket
Defined in: packages/client/src/Socket.ts:115
Methods
listen()
listen(
event,cb):this
Defined in: packages/client/src/Socket.ts:119
Bind a callback to a broadcast event on this channel. Chainable.
Parameters
event
string
cb
Listener
Returns
this
stopListening()
stopListening(
event,cb?):this
Defined in: packages/client/src/Socket.ts:127
Remove a specific listener, or all listeners for an event when cb is omitted. Chainable.
Parameters
event
string
cb?
Listener
Returns
this
error()
error(
cb):this
Defined in: packages/client/src/Socket.ts:134
Called when the server rejects the subscription (e.g. unauthorized). Chainable.
Parameters
cb
Listener
Returns
this
subscribed()
subscribed(
cb):this
Defined in: packages/client/src/Socket.ts:140
Called once the subscription is confirmed. Chainable.
Parameters
cb
Listener
Returns
this
unsubscribe()
unsubscribe():
void
Defined in: packages/client/src/Socket.ts:146
Leave (unsubscribe from) this channel.
Returns
void
_emit()
protected_emit(cbs,payload):void
Defined in: packages/client/src/Socket.ts:166
Parameters
cbs
Set<Listener>
payload
unknown
Returns
void