diff --git a/src/useFilterMessages.ts b/src/useFilterMessages.ts index 01db809..bedb56c 100644 --- a/src/useFilterMessages.ts +++ b/src/useFilterMessages.ts @@ -21,6 +21,14 @@ type UseFilterMessagesResult = HookState & { messages: IDecodedMessage[]; }; +/** + * Returns messages from Filter subscription and keeps them up to date + * @example + * const { isLoading, error, message } = useFilterMessages({node, decoder}); + * @param {Object} node - node that implements Filter, hook does nothing if undefined + * @param {Object} decoder - decoder to use for subscribing, hook does nothing if undefined + * @returns {Object} hook state (isLoading, error) and messages array + */ export const useFilterMessages = ( params: UseFilterMessagesParams, ): UseFilterMessagesResult => { diff --git a/src/useStoreMessages.ts b/src/useStoreMessages.ts index c9168af..b0c5292 100644 --- a/src/useStoreMessages.ts +++ b/src/useStoreMessages.ts @@ -23,6 +23,15 @@ type UseStoreMessagesResult = HookState & { messages: IDecodedMessage[]; }; +/** + * Hook for retrieving messages from Store protocol based on options + * @example + * const { isLoading, error, messages } = useStoreMessages({node, decoder, options}); + * @param {Object} node - node that implement Store, hook does nothing if undefined + * @param {Object} decoder - decoder to use for getting messages, hook does nothing if undefined + * @param {StoreQueryOptions} options - options to initiate query to get messages + * @returns {Object} hook state (isLoading, error) and messages array + */ export const useStoreMessages = ( params: UseStoreMessagesParams, ): UseStoreMessagesResult => {