Documentation / @agentick/client / ChannelAccessor
Interface: ChannelAccessor ​
Defined in: client/src/types.ts:101
Channel accessor for pub/sub operations.
Properties ​
name ​
readonlyname:string
Defined in: client/src/types.ts:103
Channel name
Methods ​
publish() ​
publish<
T>(type,payload):Promise<void>
Defined in: client/src/types.ts:114
Publish event to channel.
Type Parameters ​
T ​
T = unknown
Parameters ​
type ​
string
payload ​
T
Returns ​
Promise<void>
request() ​
request<
TReq,TRes>(type,payload,timeoutMs?):Promise<TRes>
Defined in: client/src/types.ts:120
Request/response pattern. Returns the response payload.
Type Parameters ​
TReq ​
TReq = unknown
TRes ​
TRes = unknown
Parameters ​
type ​
string
payload ​
TReq
timeoutMs? ​
number
Returns ​
Promise<TRes>
subscribe() ​
subscribe<
T>(handler): () =>void
Defined in: client/src/types.ts:109
Subscribe to channel events. Returns unsubscribe function.
Type Parameters ​
T ​
T = unknown
Parameters ​
handler ​
(payload, event) => void
Returns ​
():
void
Returns ​
void