From d6ba9a3c25d4d8da581904866caa321dbca97b2b Mon Sep 17 00:00:00 2001 From: Kingkor Roy Tirtho Date: Wed, 18 Oct 2023 21:37:20 +0600 Subject: [PATCH] docs: migration category --- docs/docs/migrations/V1Migration.mdx | 13 +++++++++++++ docs/docs/migrations/_category_.json | 7 +++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/docs/migrations/V1Migration.mdx create mode 100644 docs/docs/migrations/_category_.json diff --git a/docs/docs/migrations/V1Migration.mdx b/docs/docs/migrations/V1Migration.mdx new file mode 100644 index 0000000..2f494c0 --- /dev/null +++ b/docs/docs/migrations/V1Migration.mdx @@ -0,0 +1,13 @@ +--- +sidebar_position: 1 +title: V1 Migration +id: v1-migratin +--- + +Fl-Query V1 comes with lot of breaking changes in the API. It is not possible to upgrade to V1 without making changes to your code if you were using anything below V1. This page will help you to migrate to V1. + +### No Jobs API + +`QueryJob`, `MutationJob` and `InfiniteQueryJob` all were removed to bring the API closer to React Query. The `externalData` param was found to be vulnerable and was causing memory leaks. Also the query itself should react to external data changes automatically which caused massive performance drawbacks. + +Now everything needs to be passed to `QueryBuilder`, `MutationBuilder` and `InfiniteQueryBuilder` or `useQuery`, `useMutation` and `useInfiniteQuery` hooks directly. \ No newline at end of file diff --git a/docs/docs/migrations/_category_.json b/docs/docs/migrations/_category_.json new file mode 100644 index 0000000..8834963 --- /dev/null +++ b/docs/docs/migrations/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Migrations", + "position": 3, + "link": { + "type": "generated-index" + } +} \ No newline at end of file