chore(useStore): add tsdoc example

2024-02-17 14:35:20 +01:00
parent f14480dc89
commit 776f6ce0b7
1 changed files with 4 additions and 1 deletions
@@ -14,8 +14,11 @@ const zustandErrorMessage = errorMessages['error001']();
 * @param selector
 * @param equalityFn
 * @returns The selected state slice
+ *
+ * @example
+ * const nodes = useStore((state: ReactFlowState<MyNodeType>) => state.nodes);
+ *
 */
-
 function useStore<StateSlice = unknown>(
  selector: (state: ReactFlowState) => StateSlice,
  equalityFn?: (a: StateSlice, b: StateSlice) => boolean