Revise Persisting store data doc page #1497

sewera · 2022-12-29T13:52:23Z

Related Issues

Relates to #1220.

Summary

add cross-links
add line breaks for easier Markdown reading
unify Persist middleware spelling
change fishes to bears, because the plural of fish is fish,
and it would be less readable
make sentences more concise

Check List

yarn run prettier for formatting code and docs

- add cross-links - add line breaks for easier Markdown reading - unify Persist middleware spelling - change fishes to bears, because the plural of fish is fish, and it would be less readable - make sentences more concise

codesandbox-ci · 2022-12-29T13:52:53Z

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 e310f19:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration
Next.js	Configuration

sewera · 2022-12-29T13:56:09Z

docs/integrations/persisting-store-data.md

-The given name is going to be the key used to store your Zustand state in the storage, so it must be unique.
+The given name is going to be the key
+used to store your Zustand state in the storage,
+so it must be unique.

 ### `getStorage`


I found getStorage name misleading.
When I set up the Persist middleware options,
I intuitively wanted to set the storage with a storage option.
The getStorage option suggests that it doesn't set anything,
but simply returns the currently set storage.

I didn't want to change the code, but if it's possible,
I'd suggest changing getStorage to storage.

Naming getStorage means a function that returns a storage.

Anyway, #1463 will give a new option.

sewera · 2022-12-29T13:57:59Z

docs/integrations/persisting-store-data.md

  persist(
    (set, get) => ({
-      fishes: 0,
-      addAFish: () => set({ fishes: get().fishes + 1 }),
+      bears: 0,


I changed fishes to bears, because the most used
plural form of fish is "fish". Bears not only will
be less confusing in that regard, but also will
play nicely with the Zustand branding.

i like the idea of removing the ambiguity

sewera · 2022-12-29T13:59:08Z

docs/integrations/persisting-store-data.md

-```ts
-interface Storage {
-  getItem: (name: string) => string | null | Promise<string | null>
-  setItem: (name: string, value: string) => void | Promise<void>
-  removeItem: (name: string) => void | Promise<void>
-}
-```


I removed the Storage interface definition,
because it introduced unnecessary duplication
with TypeScript definition in code.

sewera · 2022-12-29T14:00:46Z

docs/integrations/persisting-store-data.md

 ### `serialize`

-> Schema: `(state: Object) => string | Promise<string>`
+> Type: `(state: Object) => string | Promise<string>`


I replaced "Schema" with "Type", because a schema reminds me more
of an API schema in remote communication, like REST or GraphQL schema.

sewera · 2022-12-29T14:02:29Z

docs/integrations/persisting-store-data.md

@@ -312,9 +334,10 @@ useBoundStore.persist.getOptions().name

 ### `setOptions`

-> Schema: `(newOptions: PersistOptions) => void`
+> Type: `(newOptions: Partial<PersistOptions>) => void`


I aligned the type with persist.ts@77.

sewera · 2022-12-29T14:04:33Z

docs/integrations/persisting-store-data.md

@@ -395,29 +424,49 @@ unsub()

 ## Hydration and asynchronous storages

-To explain what's the "cost" of asynchronous storages, you need to understand what's hydration.
-In a nutshell, hydration is the process of retrieving the persisted state from the storage and merging it with the current state.
+To explain what is the "cost" of asynchronous storages,


I introduced Semantic line breaks
for better maintainability of those paragraphs.

That is a really interesting read! Thank you for sharing (and introducing the change)

chrisk-7777

extremely well written, thank you for the changes

chrisk-7777 · 2022-12-30T01:28:35Z

docs/integrations/persisting-store-data.md

  persist(
    (set, get) => ({
-      fishes: 0,
-      addAFish: () => set({ fishes: get().fishes + 1 }),
+      bears: 0,


i like the idea of removing the ambiguity

chrisk-7777 · 2022-12-30T01:33:03Z

docs/integrations/persisting-store-data.md

@@ -395,29 +424,49 @@ unsub()

 ## Hydration and asynchronous storages

-To explain what's the "cost" of asynchronous storages, you need to understand what's hydration.
-In a nutshell, hydration is the process of retrieving the persisted state from the storage and merging it with the current state.
+To explain what is the "cost" of asynchronous storages,


That is a really interesting read! Thank you for sharing (and introducing the change)

dai-shi

Thanks for your contribution!

dai-shi · 2022-12-30T05:28:08Z

docs/integrations/persisting-store-data.md

-The given name is going to be the key used to store your Zustand state in the storage, so it must be unique.
+The given name is going to be the key
+used to store your Zustand state in the storage,
+so it must be unique.

 ### `getStorage`


Naming getStorage means a function that returns a storage.

Anyway, #1463 will give a new option.

sewera added 3 commits December 29, 2022 14:34

docs(pmndrs#1220): revise persisting-store-data page

28b8d9d

- add cross-links - add line breaks for easier Markdown reading - unify Persist middleware spelling - change fishes to bears, because the plural of fish is fish, and it would be less readable - make sentences more concise

docs(pmndrs#1220): make the sentences more concise

0cc2206

docs(pmndrs#1220): unify formatting of methods

e310f19

sewera commented Dec 29, 2022

View reviewed changes

sewera changed the title ~~Documentation update individual page audit~~ Revise Persisting store data doc page Dec 29, 2022

sewera mentioned this pull request Dec 29, 2022

[documentation update] Individual page audit #1220

Closed

16 tasks

dai-shi requested a review from chrisk-7777 December 29, 2022 14:17

chrisk-7777 approved these changes Dec 30, 2022

View reviewed changes

dai-shi reviewed Dec 30, 2022

View reviewed changes

dai-shi merged commit a8c98d6 into pmndrs:main Dec 30, 2022

sewera deleted the documentation-update-individual-page-audit branch December 30, 2022 23:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise Persisting store data doc page #1497

Revise Persisting store data doc page #1497

sewera commented Dec 29, 2022

codesandbox-ci bot commented Dec 29, 2022

sewera Dec 29, 2022

dai-shi Dec 30, 2022

sewera Dec 29, 2022

chrisk-7777 Dec 30, 2022

sewera Dec 29, 2022

sewera Dec 29, 2022

sewera Dec 29, 2022

sewera Dec 29, 2022

chrisk-7777 Dec 30, 2022

chrisk-7777 left a comment

chrisk-7777 Dec 30, 2022

chrisk-7777 Dec 30, 2022

dai-shi left a comment

dai-shi Dec 30, 2022

Revise Persisting store data doc page #1497

Revise Persisting store data doc page #1497

Conversation

sewera commented Dec 29, 2022

Related Issues

Summary

Check List

codesandbox-ci bot commented Dec 29, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisk-7777 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dai-shi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment