chore: update docs

react-hookz · Jan 28, 2023 · f833f4a · f833f4a
1 parent d70c5ee
commit f833f4a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/useStateRef/__docs__/story.mdx b/src/useStateRef/__docs__/story.mdx
@@ -29,3 +29,8 @@ export function useStateRef<Node extends HTMLElement | null, StateRef>(
 #### Arguments
 
 - **refCallback** _`(node: HTMLElement) => unknown`_ - Function which call on mount and unmount of component.
+
+#### Return
+
+- _**[0]**_ _`unknown`_ - return value of `refCallback`
+- _**[1]**_ _`(node: HTMLElement) => void`_ - handler which update `stateRef`
diff --git a/src/useStateRef/index.ts b/src/useStateRef/index.ts
@@ -5,7 +5,8 @@ import { useSyncedRef } from '../useSyncedRef';
 /**
  * Hook with callback which provide access to DOM node reference.
  *
- * @param refCallback Function which call on mount and unmount of component.
+ * @param refCallback Function which call on mount and unmount of component
+ * @returns return value of `refCallback` and handler
  */
 export const useStateRef = <Node extends HTMLElement | null, StateRef>(
   refCallback: (node: Node) => StateRef