Module "core/useClientTrigger"

useClientTrigger

• useClientTrigger<TData>(channel: Channel | PresenceChannel | undefined): (Anonymous function)

• example

  const channel = useChannel('my-channel');
  const trigger = useClientTrigger(channel)
  
  const handleClick = () => trigger('some-client-event', {});

  Type parameters

  • TData

    shape of the data you're sending with the event.

  Parameters

  • channel: Channel | PresenceChannel | undefined

    the channel you'd like to trigger clientEvents on. Get this from useChannel or usePresenceChannel.

  Returns (Anonymous function)

  A memoized trigger function that will perform client events on the channel.