State is deprecated, but still used in Docs

[dinogomez]

Summary

State is deprecated but is still shown and used in the docs.

Docs

Link to reproduction

https://docs.pmnd.rs/zustand/guides/updating-state

https://github.com/pmndrs/zustand/blob/main/docs/guides/updating-state.md

[dai-shi]

Would you like to open a PR to fix it?

[OshriAsulin]

Hi @dai-shi , I will be happy to open pr of this issue but really I didn't understanding the bug

[OshriAsulin]

I thinking @dinogomez got this error because it didn't create this next type in the image

[dai-shi]

I'm not sure either but there remains deprecated State type from zustand in docs, right?

[OshriAsulin]

Right @dai-shi , he remains the docs, but I checked this issue and I worked according to the docs and I didn't get this as an error

My test:

[dai-shi]

It looks good.

[dinogomez]

Hi @dai-shi and @OshriAsulin , I am just starting to learn Zustand and Typescript, so I wont be able to help much. I just noticed the deprecation warning when I was following the docs in vscode.

After following Oshi's reproduction I found that it was because I used a different name for state i.e userState that caused it.

After I renamed it properly it worked without warnings.

So the docs were fine, it was just a mistake on my end. Sorry for taking moments of your time and thank you for the help as well. Since everything is good ill be closing the issue. Working with zustand is such a good dev experience and really helped me with my state management issues. Cheers!

[dai-shi]

Okay, so there are no deprecated State types remained in docs.

[OshriAsulin]

Right, but I founded another issue in this is snnipet code-
Please describe what you expected to happen when using the shallow in this example from the docs-

This example is from the links from the top of this page.

when I tried to use it I got an error-

[OshriAsulin]

And when I hide this shallow is working fine

[OshriAsulin]

I will happy to work on this issue @dai-shi let me to know if I can to do that.

[dai-shi]

shallow should be there, because the selector L26 creates a new array. Not sure what is your suggestion about improving the description, but please feel free to open a PR and discuss based on it (though, in the end we may decide not to merge.)

[OshriAsulin]

I mean for improving, because the shallow is making an error so remove him from the example of the docs.
@dai-shi

[dai-shi]

Do you mean adding import { shallow } from 'zustand/shallow' improves it?

[OshriAsulin]

Do you mean adding import { shallow } from 'zustand/shallow' improves it?

Yes, It's resolved the issue. @dai-shi

But it does not exist in the docs

Untitled.video.-.Made.with.Clipchamp.2.mp4

[OshriAsulin]

So I thought about two options-
1 Add the imports to create and to shalllow as in the following example -

import { create } from 'zustand'
import { shallow } from 'zustand/shallow'

2 Remove the shallow to avoid user errors

@dai-shi let me to know which solution you want I implement?

[dai-shi]

Add import statements, because removing shallow is wrong (even if the error seems to go away.)