useSubscription

useSubscription calls the subscribe method from liveProvider when mounted. It is useful when you want to subscribe to a Realtime channel.

Usage​

import { useSubscription } from "@refinedev/core";

useSubscription({
    channel: "channel-name",
    types: ["event-name", "another-event-name"]
    onLiveEvent: (event) => {},
    dataProviderName: "default",
});

Properties​

useSubscription will be passed to the subscribe method from the liveProvider as a parameter. You can use the following properties of this method while subcribing to a channel.

channel

required

​

Channel name to subscribe to.

onLiveEvent

required

​

Callback that is run when new events from the subscription arrive.

types​

Default: ["*"]

Type of events to subscribe. "\*" means all events.

enabled​

Default: true

You can disable the subscription by setting this prop to false and vice versa.

params​

You can pass any additional parameters to the liveProvider's subscribe method.

Hooks that use useSubscription internally send the query's parameters' (pagination, meta, sort, filters, etc.) information along with this prop.

For more information on which hooks use useSubcription internally, refer to the LiveProvider's "Supported Hooks Subscription" section→

dataProviderName​

Default: "default"

You can pass the name of the data provider to use for the subscription.

API Reference​

Properties​