Skip to content
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

docs: update README #96

Merged
merged 1 commit into from
Nov 25, 2024
+3 −3
Merged

docs: update README #96

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: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@
const controller = new AbortController();
useFetchye('http://example.com/api/books', { signal: controller.signal });

useEffect(() => () => controller.abort(), []);

Check warning on line 358 in README.md

View workflow job for this annotation

GitHub Actions / Node 12.x 

React Hook useEffect has a missing dependency: 'controller'. Either include it or remove the dependency array

Check warning on line 358 in README.md

View workflow job for this annotation

GitHub Actions / Node 14.x 

React Hook useEffect has a missing dependency: 'controller'. Either include it or remove the dependency array

Check warning on line 358 in README.md

View workflow job for this annotation

GitHub Actions / Node 16.x 

React Hook useEffect has a missing dependency: 'controller'. Either include it or remove the dependency array

Check warning on line 358 in README.md

View workflow job for this annotation

GitHub Actions / Node 18.x 

React Hook useEffect has a missing dependency: 'controller'. Either include it or remove the dependency array

return (
<div>
Expand Down Expand Up @@ -888,7 +888,7 @@
|----------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `data` | `Object` | A result of a `fetchClient` query. *Defaults to returning `{ status, body, ok, headers }` from `fetchClient` response* |
| `error?` | `Object` | An object containing an error if present. *Defaults to an `Error` object with a thrown `fetch` error. This is not for API errors (e.g. Status 500 or 400). See `data` for that* |
| `run` | `async () => {}` | A function for bypassing the cache and firing an API call. Can we awaited. |
| `run` | `async () => {}` | A function for bypassing the cache and firing an API call. Can be awaited. |

### `makeOneServerFetchye`

Expand Down Expand Up @@ -926,7 +926,7 @@
|----------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `data` | `Object` | A result of a `fetchClient` query. *Defaults to returning `{ status, body, ok, headers }` from `fetchClient` response* |
| `error?` | `Object` | An object containing an error if present. *Defaults to an `Error` object with a thrown `fetch` error. This is not for API errors (e.g. Status 500 or 400). See `data` for that* |
| `run` | `async () => {}` | A function for bypassing the cache and firing an API call. Can we awaited. |
| `run` | `async () => {}` | A function for bypassing the cache and firing an API call. Can be awaited. |

### oneFetchye

Expand Down Expand Up @@ -954,7 +954,7 @@
|----------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `data` | `Object` | A result of a `fetchClient` query. *Defaults to returning `{ status, body, ok, headers }` from `fetchClient` response* |
| `error?` | `Object` | An object containing an error if present. *Defaults to an `Error` object with a thrown `fetch` error. This is not for API errors (e.g. Status 500 or 400). See `data` for that* |
| `run` | `async () => {}` | A function for bypassing the cache and firing an API call. Can we awaited. |
| `run` | `async () => {}` | A function for bypassing the cache and firing an API call. Can be awaited. |

### Providers

Expand Down
Loading