Skip to content

docs(persister): document asynchronous serialization callbacks #11411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
grzdev wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

docs(persister): document asynchronous serialization callbacks #11411

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/framework/react/plugins/createAsyncStoragePersister.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ interface CreateAsyncStoragePersisterOptions {
* pass a time in ms to throttle saving the cache to disk */
throttleTime?: number
/** How to serialize the data to storage */
serialize?: (client: PersistedClient) => string
serialize?: (client: PersistedClient) => MaybePromise<string>
/** How to deserialize the data from storage */
deserialize?: (cachedString: string) => PersistedClient
deserialize?: (cachedString: string) => MaybePromise<PersistedClient>
/** How to retry persistence on error **/
retry?: AsyncPersistRetryer
}
Expand All @@ -108,6 +108,8 @@ interface AsyncStorage<TStorageValue = string> {
}
```

The `serialize` and `deserialize` callbacks can return their results synchronously or asynchronously as promises.

The default options are:

```tsx
Expand Down