Skip to content

Commit

Permalink
docs(storeOptions): remove references to the debug option
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenjason89 committed Jan 15, 2025
1 parent aa94463 commit 53e5251
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/api/persist-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
| Property | Type | Description |
|---------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `key` | `string \| Record<keyof S, string>` | Key(s) used to store data in storage. Defaults to the store's ID. |
| `debug` | `boolean` | Enables logging for debugging purposes. Defaults to `false`. |
| `overwrite` | `boolean` | When true, replaces the entire store state with the persisted state during `$restore`. For [object keys](/guide/advance-usage.md#object-key-persistence), unmapped properties are replaced, and mapped properties are patched individually, effectively acting as an overwrite for those keys. Defaults to `false`. |
| `clientOnly` | `boolean` | Determines if storage operations should be restricted to the client environment only. Defaults to false. |
| `storage` | `Storage \| AsyncStorage` | Storage mechanism for persisting data. Supports synchronous options like `localStorage` and `cookies`, asynchronous options such as `localForage`, or fully custom storage implementations (e.g., fetching from a `remote API`). |
Expand Down

0 comments on commit 53e5251

Please sign in to comment.