diff --git a/docs/Actions.md b/docs/Actions.md index effe4812e0a..b9e1c2ff322 100644 --- a/docs/Actions.md +++ b/docs/Actions.md @@ -149,7 +149,7 @@ This object updates according to the request state: - start: `{ loading: true, loaded: false }` - success: `{ data: [data from response], total: [total from response], loading: false, loaded: true }` -- error: `{ error: [error from response], loading: false, loaded: true }` +- error: `{ error: [error from response], loading: false, loaded: false }` As a reminder, here are the read query types handled by Data Providers: @@ -228,7 +228,7 @@ This object updates according to the request state: - mount: `{ loading: false, loaded: false }` - mutate called: `{ loading: true, loaded: false }` - success: `{ data: [data from response], total: [total from response], loading: false, loaded: true }` -- error: `{ error: [error from response], loading: false, loaded: true }` +- error: `{ error: [error from response], loading: false, loaded: false }` You can destructure the return value of the `useMutation` hook as `[mutate, { data, total, error, loading, loaded }]`. diff --git a/packages/ra-core/src/dataProvider/useCreate.ts b/packages/ra-core/src/dataProvider/useCreate.ts index 162b6987041..65a38664968 100644 --- a/packages/ra-core/src/dataProvider/useCreate.ts +++ b/packages/ra-core/src/dataProvider/useCreate.ts @@ -10,7 +10,7 @@ import useMutation, { MutationOptions, Mutation } from './useMutation'; * - initial: [create, { loading: false, loaded: false }] * - start: [create, { loading: true, loaded: false }] * - success: [create, { data: [data from response], loading: false, loaded: true }] - * - error: [create, { error: [error from response], loading: false, loaded: true }] + * - error: [create, { error: [error from response], loading: false, loaded: false }] * * @param resource The resource name, e.g. 'posts' * @param data The data to initialize the new record with, e.g. { title: 'hello, world' } diff --git a/packages/ra-core/src/dataProvider/useDelete.ts b/packages/ra-core/src/dataProvider/useDelete.ts index a578364302f..cd9b3d42968 100644 --- a/packages/ra-core/src/dataProvider/useDelete.ts +++ b/packages/ra-core/src/dataProvider/useDelete.ts @@ -11,7 +11,7 @@ import useMutation, { MutationOptions, Mutation } from './useMutation'; * - initial: [deleteOne, { loading: false, loaded: false }] * - start: [deleteOne, { loading: true, loaded: false }] * - success: [deleteOne, { data: [data from response], loading: false, loaded: true }] - * - error: [deleteOne, { error: [error from response], loading: false, loaded: true }] + * - error: [deleteOne, { error: [error from response], loading: false, loaded: false }] * * @param resource The resource name, e.g. 'posts' * @param id The resource identifier, e.g. 123 diff --git a/packages/ra-core/src/dataProvider/useDeleteMany.ts b/packages/ra-core/src/dataProvider/useDeleteMany.ts index bbddf516c58..94184e1fe20 100644 --- a/packages/ra-core/src/dataProvider/useDeleteMany.ts +++ b/packages/ra-core/src/dataProvider/useDeleteMany.ts @@ -11,7 +11,7 @@ import useMutation, { MutationOptions, Mutation } from './useMutation'; * - initial: [deleteMany, { loading: false, loaded: false }] * - start: [deleteMany, { loading: true, loaded: false }] * - success: [deleteMany, { data: [data from response], loading: false, loaded: true }] - * - error: [deleteMany, { error: [error from response], loading: false, loaded: true }] + * - error: [deleteMany, { error: [error from response], loading: false, loaded: false }] * * @param resource The resource name, e.g. 'posts' * @param ids The resource identifiers, e.g. [123, 456] diff --git a/packages/ra-core/src/dataProvider/useGetList.ts b/packages/ra-core/src/dataProvider/useGetList.ts index 89119eb881a..b703aeceabf 100644 --- a/packages/ra-core/src/dataProvider/useGetList.ts +++ b/packages/ra-core/src/dataProvider/useGetList.ts @@ -26,7 +26,7 @@ const defaultData = {}; * * - start: { loading: true, loaded: false } * - success: { data: [data from store], ids: [ids from response], total: [total from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useGetMainList.tsx b/packages/ra-core/src/dataProvider/useGetMainList.tsx index 8da0d517db0..70d42f599eb 100644 --- a/packages/ra-core/src/dataProvider/useGetMainList.tsx +++ b/packages/ra-core/src/dataProvider/useGetMainList.tsx @@ -25,7 +25,7 @@ const defaultData = {}; * * - start: { loading: true, loaded: false } * - success: { data: [data from store], ids: [ids from response], total: [total from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useGetMany.ts b/packages/ra-core/src/dataProvider/useGetMany.ts index 6252694be3c..09523cb74e5 100644 --- a/packages/ra-core/src/dataProvider/useGetMany.ts +++ b/packages/ra-core/src/dataProvider/useGetMany.ts @@ -51,7 +51,7 @@ const DataProviderOptions = { action: CRUD_GET_MANY }; * * - start: { loading: true, loaded: false } * - success: { data: [data from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useGetManyReference.ts b/packages/ra-core/src/dataProvider/useGetManyReference.ts index b3ea948b560..9c246704232 100644 --- a/packages/ra-core/src/dataProvider/useGetManyReference.ts +++ b/packages/ra-core/src/dataProvider/useGetManyReference.ts @@ -35,7 +35,7 @@ interface UseGetManyReferenceOptions { * * - start: { loading: true, loaded: false } * - success: { data: [data from store], ids: [ids from response], total: [total from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useGetMatching.ts b/packages/ra-core/src/dataProvider/useGetMatching.ts index 1738e81a92a..a2866bcb22c 100644 --- a/packages/ra-core/src/dataProvider/useGetMatching.ts +++ b/packages/ra-core/src/dataProvider/useGetMatching.ts @@ -37,7 +37,7 @@ const referenceSource = (resource, source) => `${resource}@${source}`; * * - start: { loading: true, loaded: false } * - success: { data: [data from store], ids: [ids from response], total: [total from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useGetOne.ts b/packages/ra-core/src/dataProvider/useGetOne.ts index df83de560a6..a3197365f4b 100644 --- a/packages/ra-core/src/dataProvider/useGetOne.ts +++ b/packages/ra-core/src/dataProvider/useGetOne.ts @@ -16,7 +16,7 @@ import { useQueryWithStore } from './useQueryWithStore'; * * - start: { loading: true, loaded: false } * - success: { data: [data from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useMutation.ts b/packages/ra-core/src/dataProvider/useMutation.ts index fb76487e707..f49173c5d3c 100644 --- a/packages/ra-core/src/dataProvider/useMutation.ts +++ b/packages/ra-core/src/dataProvider/useMutation.ts @@ -45,7 +45,7 @@ import { DeclarativeSideEffect } from './useDeclarativeSideEffects'; * - mount: [mutate, { loading: false, loaded: false }] * - mutate called: [mutate, { loading: true, loaded: false }] * - success: [mutate, { data: [data from response], total: [total from response], loading: false, loaded: true }] - * - error: [mutate, { error: [error from response], loading: false, loaded: true }] + * - error: [mutate, { error: [error from response], loading: false, loaded: false }] * * The mutate function accepts the following arguments * - {Object} query diff --git a/packages/ra-core/src/dataProvider/useQuery.ts b/packages/ra-core/src/dataProvider/useQuery.ts index 23fab41695e..bddeda46027 100644 --- a/packages/ra-core/src/dataProvider/useQuery.ts +++ b/packages/ra-core/src/dataProvider/useQuery.ts @@ -15,7 +15,7 @@ import { DataProviderQuery, Refetch } from './useQueryWithStore'; * * - start: { loading: true, loaded: false } * - success: { data: [data from response], total: [total from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * @param {Object} query * @param {string} query.type The method called on the data provider, e.g. 'getList', 'getOne'. Can also be a custom method if the dataProvider supports is. diff --git a/packages/ra-core/src/dataProvider/useQueryWithStore.ts b/packages/ra-core/src/dataProvider/useQueryWithStore.ts index 48086899187..0d5c7930be0 100644 --- a/packages/ra-core/src/dataProvider/useQueryWithStore.ts +++ b/packages/ra-core/src/dataProvider/useQueryWithStore.ts @@ -72,7 +72,7 @@ const defaultIsDataLoaded = (data: any): boolean => data !== undefined; * * - start: { loading: true, loaded: false } * - success: { data: [data from response], total: [total from response], loading: false, loaded: true } - * - error: { error: [error from response], loading: false, loaded: true } + * - error: { error: [error from response], loading: false, loaded: false } * * This hook will return the cached result when called a second time * with the same parameters, until the response arrives. diff --git a/packages/ra-core/src/dataProvider/useUpdate.ts b/packages/ra-core/src/dataProvider/useUpdate.ts index 4395d82d526..6245478e72a 100644 --- a/packages/ra-core/src/dataProvider/useUpdate.ts +++ b/packages/ra-core/src/dataProvider/useUpdate.ts @@ -10,7 +10,7 @@ import useMutation, { MutationOptions, Mutation } from './useMutation'; * - initial: [update, { loading: false, loaded: false }] * - start: [update, { loading: true, loaded: false }] * - success: [update, { data: [data from response], loading: false, loaded: true }] - * - error: [update, { error: [error from response], loading: false, loaded: true }] + * - error: [update, { error: [error from response], loading: false, loaded: false }] * * @param resource The resource name, e.g. 'posts' * @param id The resource identifier, e.g. 123 diff --git a/packages/ra-core/src/dataProvider/useUpdateMany.ts b/packages/ra-core/src/dataProvider/useUpdateMany.ts index bed545d933c..7897a7906f7 100644 --- a/packages/ra-core/src/dataProvider/useUpdateMany.ts +++ b/packages/ra-core/src/dataProvider/useUpdateMany.ts @@ -11,7 +11,7 @@ import useMutation, { MutationOptions, Mutation } from './useMutation'; * - initial: [updateMany, { loading: false, loaded: false }] * - start: [updateMany, { loading: true, loaded: false }] * - success: [updateMany, { data: [data from response], loading: false, loaded: true }] - * - error: [updateMany, { error: [error from response], loading: false, loaded: true }] + * - error: [updateMany, { error: [error from response], loading: false, loaded: false }] * * @param resource The resource name, e.g. 'posts' * @param ids The resource identifiers, e.g. [123, 456]