alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(useStore): add tsdoc example

Browse Source
This commit is contained in:
moklick
2024-02-17 14:35:20 +01:00
parent f14480dc89
commit 776f6ce0b7
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/react/src/hooks/useStore.ts
+4 -1
View File
@@ -14,8 +14,11 @@ const zustandErrorMessage = errorMessages['error001']();
* @param selector * @param selector
* @param equalityFn * @param equalityFn
* @returns The selected state slice * @returns The selected state slice
*
* @example
* const nodes = useStore((state: ReactFlowState<MyNodeType>) => state.nodes);
*
*/ */
function useStore<StateSlice = unknown>( function useStore<StateSlice = unknown>(
selector: (state: ReactFlowState) => StateSlice, selector: (state: ReactFlowState) => StateSlice,
equalityFn?: (a: StateSlice, b: StateSlice) => boolean equalityFn?: (a: StateSlice, b: StateSlice) => boolean