@towns-protocol/react-sdk
Version:
React Hooks for Towns Protocol SDK
12 lines • 717 B
TypeScript
import type { Channel } from '@towns-protocol/sdk';
import { type ObservableConfig } from './useObservable';
/**
* Hook to get data about a channel.
* You can use this hook to get channel metadata and if the user has joined the channel.
* @param spaceId - The id of the space the channel belongs to.
* @param channelId - The id of the channel to get data about.
* @param config - Configuration options for the observable.
* @returns The ChannelModel data.
*/
export declare const useChannel: (spaceId: string, channelId: string, config?: ObservableConfig.FromObservable<Channel>) => import("./useObservable").ObservableValue<import("@towns-protocol/sdk").ChannelModel>;
//# sourceMappingURL=useChannel.d.ts.map