useCustomMutation

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 "@pankod/refine-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",
  },
});

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

Refer to the useMutation documentation for more information →

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

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!
    },
  },
);

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",
});

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",
});

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",
  },
});

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",
    },
  },
});

NotificationProvider is required for this prop to work.

After data is fetched successfully, useCustomMutation can call open function from NotificationProvider to show a success notification. With this prop, you can customize the success notification.

const { mutate } = useCustomMutation();

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

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, resource) => {
    return {
      message: `Something went wrong when getting ${data.id}`,
      description: "Error",
      type: "error",
    };
  },
});

metaData is used following two purposes:

• To pass additional information to data provider methods.
• Generate GraphQL queries using plain JavaScript Objects (JSON). Please refer GraphQL for more information.

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

const { mutate } = useCustomMutation();

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

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

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

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

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",
});

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

Refer to the useMutation documentation for more information →