Skip to content

Commit

Permalink
Delete refetch from createQueryResource
Browse files Browse the repository at this point in the history
  • Loading branch information
igorkamyshev committed Feb 8, 2023
1 parent c395f27 commit 065cede
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .changeset/lemon-pets-sleep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@farfetched/solid': minor
---

Delete `refetch` from `createQueryResource`
41 changes: 41 additions & 0 deletions apps/website/docs/releases/0-8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# v0.7

## Migration guide

### Do not use `refetch` in `@farfetched/solid`

`refetch` was deprecated in [v0.7](/releases/0-7), use `start` instead.

::: code-group

```tsx [before]
import { createQueryResource } from '@farfetched/solid';

function User() {
const [user, { refetch }] = createQueryResource(userQuery);

return (
<div>
<button onClick={refetch}>Start query</button>
</div>
);
}
```

```tsx [after]
import { createQueryResource } from '@farfetched/solid';

function User() {
const [user, { start }] = createQueryResource(userQuery);

return (
<div>
<button onClick={start}>Start query</button>
</div>
);
}
```

:::

<!--@include: ./0-8.changelog.md-->
6 changes: 1 addition & 5 deletions packages/solid/src/create_query_resource.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ function createQueryResource<Params, Data, Error>(
): [
Resource<Data | undefined>,
{
/**
* @deprecated use `start` instead
*/
refetch: (params: Params) => void;
start: (params: Params) => void;
}
] {
Expand Down Expand Up @@ -52,7 +48,7 @@ function createQueryResource<Params, Data, Error>(
// Bind to suspense
const [resourceData] = createResource(track, () => dataDefer.promise);

return [resourceData, { refetch: start, start }];
return [resourceData, { start }];
}

export { createQueryResource };

0 comments on commit 065cede

Please sign in to comment.