Skip to content

Commit

Permalink
Modify examples inside weakMapMemoize JSDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
aryaemami59 committed Jan 3, 2024
1 parent bfbdba5 commit 684b00a
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions src/weakMapMemoize.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,18 @@ export interface WeakMapMemoizeOptions<Result = any> {
* ```ts
* useSelector(state => selectSomeData(state, props.category))
* ```
*
* **Note**: Starting in Reselect 5.0.0, `weakMapMemoize` is the default
* memoizer used in `createSelector`.
*
* @param func - The function to be memoized.
* @param options - An options object containing an optional `resultEqualityCheck` function.
* @returns A memoized function with a `.clearCache()` method attached.
*
* @example
* <caption>Using `createSelector`</caption>
* ```ts
* import { shallowEqual } from 'react-redux'
* import { createSelector, weakMapMemoize } from 'reselect'
*
* interface RootState {
Expand All @@ -140,17 +146,33 @@ export interface WeakMapMemoizeOptions<Result = any> {
* (items, category) => items.filter(item => item.category === category),
* {
* memoize: weakMapMemoize,
* argsMemoize: weakMapMemoize
* argsMemoize: weakMapMemoize,
* argsMemoizeOptions: {
* resultEqualityCheck: shallowEqual
* },
* memoizeOptions: {
* resultEqualityCheck: shallowEqual
* }
* }
* )
* ```
*
* @example
* <caption>Using `createSelectorCreator`</caption>
* ```ts
* import { shallowEqual } from 'react-redux'
* import { createSelectorCreator, weakMapMemoize } from 'reselect'
*
* const createSelectorWeakMap = createSelectorCreator({ memoize: weakMapMemoize, argsMemoize: weakMapMemoize })
* const createSelectorWeakMap = createSelectorCreator({
* memoize: weakMapMemoize,
* argsMemoize: weakMapMemoize,
* argsMemoizeOptions: {
* resultEqualityCheck: shallowEqual
* },
* memoizeOptions: {
* resultEqualityCheck: shallowEqual
* }
* })
*
* const selectItemsByCategory = createSelectorWeakMap(
* [
Expand Down

0 comments on commit 684b00a

Please sign in to comment.