useMessage

function useMessage<M, R, K>(
   channel,
   type,
   handler,
   options?): void;

Subscribe to one message type. The handler is kept fresh without resubscribing, so it may close over render state.

Type Parameters

Type Parameter
M extends MessageMap
R extends Partial<Record<keyof M, unknown>>
K extends string

Parameters

Parameter	Type
channel	Channel<M, R>
type	K
handler	(payload, meta) => void
options?	UseMessageOptions

Returns

void