Skip to content

Commit

Permalink
Improve doc
Browse files Browse the repository at this point in the history
alijany committed Jun 25, 2024

Verified

This commit was signed with the committer’s verified signature.
MauriceVanVeen Maurice van Veen
1 parent 1b0b084 commit 6618613
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -126,6 +126,9 @@ This hook retrieves cached data based on a specified `key`. If the data is not c
- `options`: An object containing configuration options.
- `isWebPlatform`: Boolean flag indicating if the platform is web (`true`) or not (`false`).

**Returns:**
- The cached data if available, otherwise `null`.

**Usage Note:**
If using in React Native and the platform is web-based (`Platform.OS === 'web'`), set `isWebPlatform` to `true` in the options object.

@@ -148,12 +151,6 @@ const MyComponent = () => {
This hook is particularly useful for efficiently managing server-side rendering (SSR) caches across different platforms.


**Parameters:**
- `key` (string): The key used to store and retrieve the cached data.

**Returns:**
- The cached data if available, otherwise `null`.

### `<SsrCache data={data} name="key" />`

A component to cache data during server-side rendering.

0 comments on commit 6618613

Please sign in to comment.