Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
manzoorwanijk committed Nov 6, 2024
1 parent 2514dbb commit 7a6106b
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions packages/data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,11 +423,11 @@ When registering a control created with `createRegistryControl` with a store, th

_Parameters_

- _registryControl_ `Function`: Function receiving a registry object and returning a control.
- _registryControl_ `T & { isRegistryControl?: boolean; }`: Function receiving a registry object and returning a control.

_Returns_

- `Function`: Registry control that can be registered with a store.
- Registry control that can be registered with a store.

### createRegistrySelector

Expand Down Expand Up @@ -476,11 +476,11 @@ with a store.

_Parameters_

- _registrySelector_ `Function`: Function receiving a registry `select` function and returning a state selector.
- _registrySelector_ `( select: ) => Selector`: Function receiving a registry `select` function and returning a state selector.

_Returns_

- `Function`: Registry selector that can be registered with a store.
- `Selector`: Registry selector that can be registered with a store.

### createSelector

Expand All @@ -490,15 +490,6 @@ _Related_

- The documentation for the `rememo` package from which the `createSelector` function is reexported.

_Parameters_

- _selector_ `Function`: Selector function that calculates a value from state and parameters.
- _getDependants_ `Function`: Function that returns an array of "dependant" objects.

_Returns_

- `Function`: A memoized version of `selector` that caches the calculated return values.

### dispatch

Given a store descriptor, returns an object of the store's action creators. Calling an action creator will cause it to be dispatched, updating the state value accordingly.
Expand Down

0 comments on commit 7a6106b

Please sign in to comment.