UNPKG

@selfcommunity/react-core

Version:

React Core Components useful for integrating UI Community components (react-ui).

30 lines (27 loc) 900 B
import { SCBroadcastMessageType } from '@selfcommunity/types'; import { SCPaginatedResponse } from '@selfcommunity/api-services'; import { CacheStrategies } from '@selfcommunity/utils'; /** :::info This custom hook is used to fetch broadcast messages. :::tip Context can be consumed in this way: ```jsx const {messages, isLoading} = useSCFetchBroadcastMessages(); ``` ::: * @param props */ declare const useSCFetchBroadcastMessages: (props?: { cacheStrategy?: CacheStrategies; }) => { data: SCPaginatedResponse<SCBroadcastMessageType>; loading: boolean; fetchMessages: (refresh?: boolean) => Promise<SCPaginatedResponse<SCBroadcastMessageType>>; setMessages: (messages: SCBroadcastMessageType[]) => { results: SCBroadcastMessageType[]; next: string; count: number; previous: string; }; }; export default useSCFetchBroadcastMessages;