@towns-protocol/react-sdk/dist/esm/useTimeline.js

React Hooks for Towns Protocol SDK

import { Space, assert } from '@towns-protocol/sdk';
import { useMemo } from 'react';
import { useObservable } from './useObservable';
import { getRoom } from './utils';
import { useSyncAgent } from './useSyncAgent';
/**
 * Hook to get the timeline events from a stream.
 *
 * You can use the `useTimeline` hook to get the timeline events from a channel stream, dm stream or group dm stream
 *
 * @example
 * ```ts
 * import { useTimeline } from '@towns-protocol/react-sdk'
 * import { RiverTimelineEvent } from '@towns-protocol/sdk'
 *
 * const { data: events } = useTimeline(streamId)
 *
 * // You can filter the events by their kind
 * const messages = events.filter((event) => event.content?.kind === RiverTimelineEvent.ChannelMessage)
 * ```
 *
 * @param streamId - The id of the stream to get the timeline events from.
 * @param config - Configuration options for the observable.
 * @returns The timeline events of the stream as an observable.
 */
export const useTimeline = (streamId, config) => {
    const sync = useSyncAgent();
    const room = useMemo(() => getRoom(sync, streamId), [streamId, sync]);
    assert(!(room instanceof Space), 'Space does not have timeline');
    return useObservable(room.timeline.events, config);
};
//# sourceMappingURL=useTimeline.js.map