feat: deprecate equalityFn and add createWithEqualityFn

[dai-shi]

Related Issues or Discussions

Fixes #1937

Summary

See #1937

Caveat 1: createWithEqualityFn has nothing to do with subscribeWithSelector middleware and we still need to specify equalityFn such as shallow for subscribeWithSelector.

Check List

• yarn run prettier for formatting code and docs

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
zustand-demo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 31, 2023 0:36am

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 31235a6:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration
Next.js	Configuration
@pavlobu/zustand demo	Configuration

[github-actions]

Size Change: +3.11 kB (+8%) 🔍

Total Size: 43.2 kB

Filename	Size	Change
dist/context.js	782 B	+16 B (+2%)
dist/esm/context.js	590 B	+18 B (+3%)
dist/esm/index.js	640 B	+67 B (+12%)	⚠️
dist/index.js	790 B	+65 B (+9%)	🔍
dist/system/context.development.js	697 B	+17 B (+3%)
dist/system/context.production.js	386 B	+21 B (+6%)	🔍
dist/system/index.development.js	800 B	+65 B (+9%)	🔍
dist/umd/context.development.js	887 B	+19 B (+2%)
dist/umd/context.production.js	556 B	+23 B (+4%)
dist/umd/index.development.js	922 B	+67 B (+8%)	🔍
dist/esm/traditional.js	392 B	+392 B (new file)	🆕
dist/system/traditional.development.js	505 B	+505 B (new file)	🆕
dist/system/traditional.production.js	342 B	+342 B (new file)	🆕
dist/traditional.js	433 B	+433 B (new file)	🆕
dist/umd/traditional.development.js	613 B	+613 B (new file)	🆕
dist/umd/traditional.production.js	447 B	+447 B (new file)	🆕

ℹ️ View Unchanged

Filename	Size
dist/esm/middleware.js	3.87 kB
dist/esm/middleware/immer.js	210 B
dist/esm/shallow.js	509 B
dist/esm/vanilla.js	629 B
dist/middleware.js	4.43 kB
dist/middleware/immer.js	328 B
dist/shallow.js	1.11 kB
dist/system/index.production.js	402 B
dist/system/middleware.development.js	4 kB
dist/system/middleware.production.js	2.62 kB
dist/system/middleware/immer.development.js	292 B
dist/system/middleware/immer.production.js	187 B
dist/system/shallow.development.js	558 B
dist/system/shallow.production.js	344 B
dist/system/vanilla.development.js	672 B
dist/system/vanilla.production.js	310 B
dist/umd/index.production.js	533 B
dist/umd/middleware.development.js	4.58 kB
dist/umd/middleware.production.js	2.97 kB
dist/umd/middleware/immer.development.js	482 B
dist/umd/middleware/immer.production.js	342 B
dist/umd/shallow.development.js	1.23 kB
dist/umd/shallow.production.js	883 B
dist/umd/vanilla.development.js	800 B
dist/umd/vanilla.production.js	410 B
dist/vanilla.js	683 B

_{compressed-size-action}