Skip to content

Commit 7e25467

Browse files
committed
feat: update useStore docs, add shallowEqual helper, and refine release workflow
1 parent 6f673cb commit 7e25467

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ jobs:
2222
- uses: actions/setup-node@v4
2323
with:
2424
node-version: '22'
25+
registry-url: 'https://registry.npmjs.org'
2526
- name: Create Release PR or Detect Publishable Versions
2627
id: changesets
2728
uses: changesets/action@v1
@@ -46,7 +47,7 @@ jobs:
4647
- name: Create git tags
4748
if: steps.changesets.outputs.hasChangesets == 'false'
4849
run: |
49-
npx changeset tag
50+
bunx changeset tag
5051
git push --follow-tags
5152
env:
5253
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

packages/classy-store/src/react/react.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import type {Snapshot} from '../types';
1616
* Re-renders only when the selected value changes (compared via `Object.is`
1717
* by default, or a custom `isEqual`).
1818
*
19-
* @param proxyStore - A reactive proxy created by `store()`.
19+
* @param proxyStore - A reactive proxy created by `createClassyStore()`.
2020
* @param selector - Picks data from the immutable snapshot.
2121
* @param isEqual - Optional custom equality function (default: `Object.is`).
2222
*/
@@ -32,7 +32,7 @@ export function useStore<T extends object, S>(
3232
* Returns a `proxy-compare` tracking proxy over the immutable snapshot.
3333
* The component only re-renders when a property it actually read changes.
3434
*
35-
* @param proxyStore - A reactive proxy created by `store()`.
35+
* @param proxyStore - A reactive proxy created by `createClassyStore()`.
3636
*/
3737
export function useStore<T extends object>(proxyStore: T): Snapshot<T>;
3838

packages/classy-store/src/utils/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* - `devtools(store, options?)` -- connect a store to Redux DevTools for inspection and time-travel
77
* - `subscribeKey(store, key, callback)` -- subscribe to changes on a single property
88
* - `withHistory(store, options?)` -- add undo/redo capability via a snapshot stack
9+
* - `shallowEqual(a, b)` -- shallow equality helper for use with `useStore` selectors
910
*
1011
* @module @codebelt/classy-store/utils
1112
*/

0 commit comments

Comments
 (0)