Skip to main content
Version: 4.xx.xx
Source Code

useCustomMutation

useCustomMutation is used when sending custom mutation requests using the TanStack Query advantages. It is an extended version of TanStack Query's useMutation and not only supports all features of the mutation but also adds some extra features.

It uses the custom method as the mutation function from the dataProvider which is passed to <Refine>.

attention

useCustomMutation should not be used when creating, updating, or deleting a resource. Following hooks should be used for these instead: useCreate, useUpdate or useDelete.

This is because useCustomMutation, unlike other data hooks, does not invalidate queries and therefore will not update the application state either.

If you need to custom query request, use the useCustom hook.

Basic Usage​

The useCustomMutation hook returns many useful properties and methods. One of them is the mutate method which expects values, method, and url as parameters. These parameters will be passed to the custom method from the dataProvider as parameters.

import { useCustomMutation, useApiUrl } from "@refinedev/core";

interface ICategory {
id: number;
title: string;
}

const apiUrl = useApiUrl();

const { mutate } = useCustomMutation<ICategory>();

mutate({
url: `${API_URL}/categories`,
method: "post",
values: {
title: "New Category",
},
});

Properties​

mutationOptions​

mutationOptions is used to pass options to the useMutation hook. It is useful when you want to pass additional options to the useMutation hook.

For more information, refer to the useMutation documentation β†’

useCustomMutation({
mutationOptions: {
retry: 3,
},
});
TIP

mutationOptions does not support onSuccess and onError props because they override the default onSuccess and onError functions. If you want to use these props, you can pass them to mutate functions like this:

const { mutate } = useCustomMutation();

mutate(
{
url: `${API_URL}/categories`,
method: "post",
values: {
title: "New Category",
},
},
{
onError: (error, variables, context) => {
// An error occurred!
},
onSuccess: (data, variables, context) => {
// Let's celebrate!
},
},
);

Mutation Parameters​

url
required
​

It will be passed to the custom method from the dataProvider as a parameter. It is usually used to specify the endpoint of the request.

const { mutate } = useCustomMutation();

mutate({
url: "www.example.com/api/update-products",
});

method
required
​

It will be passed to the custom method from the dataProvider as a parameter. It is usually used to specify the HTTP method of the request.

const { mutate } = useCustomMutation();

mutate({
method: "post",
});

values
required
​

It will be passed to the custom method from the dataProvider as a parameter. The parameter is usually used as the data to be sent with the request.

const { mutate } = useCustomMutation();

mutate({
values: {
name: "New Category",
description: "New Category Description",
},
});

config.headers​

It will be passed to the custom method from the dataProvider as a parameter. It can be used to specify the headers of the request.

const { mutate } = useCustomMutation();

mutate({
config: {
headers: {
"x-custom-header": "foo-bar",
},
},
});

successNotification​

CAUTION

NotificationProvider is required for this prop to work.

This prop allows you to customize the success notification that shows up when the data is fetched successfully and useCustomMutation calls the open function from NotificationProvider:

const { mutate } = useCustomMutation();

mutate({
successNotification: (data, values) => {
return {
message: `${data.title} Successfully fetched.`,
description: "Success with no errors",
type: "success",
};
},
});

errorNotification​

NotificationProvider is required for this prop to work.

After data fetching is failed, useCustomMutation will call open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

const { mutate } = useCustomMutation();

mutate({
errorNotification: (data, values) => {
return {
message: `Something went wrong when getting ${data.id}`,
description: "Error",
type: "error",
};
},
});

meta​

meta is a special property that can be used to pass additional information to data provider methods for the following purposes:

  • Customizing the data provider methods for specific use cases.
  • Generating GraphQL queries using plain JavaScript Objects (JSON).

In the following example, meta is passed to the custom method from the dataProvider as a parameter.

const { mutate } = useCustomMutation();

mutate({
meta: {
foo: "bar",
},
});

const myDataProvider = {
//...
custom: async ({ url, method, sort, filters, payload, query, headers, meta }) => {
const foo = meta?.foo;

console.log(foo); // "bar"

//...
},
//...
};

For more information, refer to the meta section of the General Concepts documentation→

dataProviderName​

If there is more than one dataProvider, you can specify which one to use by passing the dataProviderName prop. It is useful when you have a different data provider for different resources.

const { mutate } = useCustomMutation();

mutate({
dataProviderName: "second-data-provider",
});

overtimeOptions​

If you want loading overtime for the request, you can pass the overtimeOptions prop to the this hook. It is useful when you want to show a loading indicator when the request takes too long. interval is the time interval in milliseconds. onInterval is the function that will be called on each interval.

Return overtime object from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useCustomMutation({
//...
overtimeOptions: {
interval: 1000,
onInterval(elapsedInterval) {
console.log(elapsedInterval);
},
},
});

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

// You can use it like this:
{
elapsedTime >= 4000 && <div>this takes a bit longer than expected</div>;
}

Return Values​

Returns an object with TanStack Query's useMutation return values.

Refer to the useMutation documentation for more information β†’

Additional Values​

overtime​

overtime object is returned from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useCustomMutation();

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

API​

Mutation Parameters​

PropertyDescriptionType
url
Required
URLstring
method
Required
Methodpost, put, patch, delete
values
Required
Values for mutation functionTVariables
configThe config of your request. You can send headers using this field.{ headers?: {}; }
successNotificationSuccessful mutation notificationSuccessErrorNotification
errorNotificationUnsuccessful mutation notificationSuccessErrorNotification
metaMeta data query for dataProviderMetaDataQuery
dataProviderNameIf there is more than one dataProvider, you should use the dataProviderName that you will use.string

Type Parameters​

PropertyDescriptionTypeDefault
TDataResult data of the query. Extends BaseRecordBaseRecordBaseRecord
TErrorCustom error object that extends HttpErrorHttpErrorHttpError
TQueryValues for query params.TQueryunknown
TPayloadValues for params.TPayloadunknown

Return value​

DescriptionType
Result of the TanStack Query's useMutationUseMutationResult<{ data: TData }, TError, { resource: string; values: TVariables; }, unknown>
overtime{ elapsedTime?: number }