fix(traditional): make defaultEqualityFn optional in TS Types

[charkour]

Summary

With the updates in v4.4.0 and the addition of the createWithEqualityFn, the types currently require defaultEqualityFn when the implementation itself is optional.

Thank you

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	Sep 18, 2023 8:06pm

[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 40065b0:

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

[charkour]

Size Change: 0 B

Total Size: 43.5 kB

ℹ️ View Unchanged

Filename	Size
dist/context.js	782 B
dist/esm/context.js	590 B
dist/esm/index.js	706 B
dist/esm/middleware.js	3.87 kB
dist/esm/middleware/immer.js	210 B
dist/esm/shallow.js	509 B
dist/esm/traditional.js	392 B
dist/esm/vanilla.js	629 B
dist/index.js	868 B
dist/middleware.js	4.43 kB
dist/middleware/immer.js	328 B
dist/shallow.js	1.11 kB
dist/system/context.development.js	697 B
dist/system/context.production.js	386 B
dist/system/index.development.js	873 B
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/traditional.development.js	505 B
dist/system/traditional.production.js	342 B
dist/system/vanilla.development.js	672 B
dist/system/vanilla.production.js	310 B
dist/traditional.js	433 B
dist/umd/context.development.js	887 B
dist/umd/context.production.js	556 B
dist/umd/index.development.js	999 B
dist/umd/index.production.js	543 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/traditional.development.js	613 B
dist/umd/traditional.production.js	447 B
dist/umd/vanilla.development.js	800 B
dist/umd/vanilla.production.js	410 B
dist/vanilla.js	683 B

_{compressed-size-action}

[dai-shi]

That was intentional to let people use it more explicitly, but I can accept this PR if people want. Please let us know if anyone else has opinion on this.

[charkour]

Thanks for the quick response. If the equalityFn should be required, that is fine. There are two concerns that caused me to suggest changes:

1. The v4.4.0 release notes are potentially misleading. Currently, it says // Object.is the default equalityFn which can be changed to shallow or anything else which suggests the equalityFn will be set to Object.is if no function is passed. If an equalityFn should be passed, this wording should be updated to say // Object.is is the default quailtyFn in zustand create; to match that behavior, pass that function here. This can be updated to shallow or anything else.
2. The TypeScript function type signature does not match the actual function signature. On line 94 in traditional.ts, the equalityFn is optional, but on line 68 and 72, the parameter is required.

Whatever behavior you'd like is fine. I understand both ways. My goal is to avoid confusion by updating the docs or types. What do you think, @dai-shi?

[dai-shi]

1 is the right concern. We can update it.
2 is fine because we just limit types from the implementation. But it may confuse people.

Any thoughts from @dbritto-dev @sewera @chrisk-7777 ?

[sewera]

I definitely agree with 1. 2 — I've got no opinion.

[dai-shi]

Updated v4.4.0 release note as suggested.

Basically, I would like to merge this PR. Just hope to get some more comments.

[charkour]

The updated release notes read more clearly. Thanks, @dai-shi!

[dai-shi]

Let's merge this.