API reference / @chanx-js/client / core / ChanxClient
Interface: ChanxClient
Defined in: packages/client/src/core/client.ts:113
Properties
options
ts
readonly options: ClientOptions;Defined in: packages/client/src/core/client.ts:114
Methods
closeAll()
ts
closeAll(code?, reason?): void;Defined in: packages/client/src/core/client.ts:123
Terminate every socket this client opened, for every consumer (on logout, say). Consumers see closed and do not reconnect; the next connect() starts fresh.
Parameters
| Parameter | Type |
|---|---|
code? | number |
reason? | string |
Returns
void
connect()
ts
connect<D>(descriptor, options?): ChannelConnection<ToServerOf<D>, ToClientOf<D>>;Defined in: packages/client/src/core/client.ts:115
Type Parameters
| Type Parameter |
|---|
D extends ChannelDescriptor<any, any, any, any> |
Parameters
| Parameter | Type |
|---|---|
descriptor | D |
options? | ConnectOptions<AddressOf<D>> |
Returns
ChannelConnection<ToServerOf<D>, ToClientOf<D>>
urlFor()
ts
urlFor<D>(descriptor, options?): string;Defined in: packages/client/src/core/client.ts:125
The URL a descriptor resolves to, without opening anything.
Type Parameters
| Type Parameter |
|---|
D extends ChannelDescriptor<any, any, any, any> |
Parameters
| Parameter | Type |
|---|---|
descriptor | D |
options? | ConnectOptions<AddressOf<D>> |
Returns
string