useCustom

The useCustom hook expects a url and method properties. These parameters will be passed to the custom method from the dataProvider as a parameter.

When properties are changed, the useCustom hook will trigger a new request.

import { useCustom, useApiUrl } from "@pankod/refine-core";

interface PostUniqueCheckResponse {
  isAvailable: boolean;
}

const apiUrl = useApiUrl();

const { data, isLoading } = useCustom<PostUniqueCheckResponse>({
  url: `${apiUrl}/posts-unique-check`,
  method: "get",
  config: {
    headers: {
      "x-custom-header": "foo-bar",
    },
    query: {
      title: "Foo bar",
    },
  },
});

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.

useCustom({
  url: "www.example.com/api/get-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.

useCustom({
  method: "get",
});

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.

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

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

useCustom({
  config: {
    query: {
      title: "Foo bar",
    },
  },
});

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

useCustom({
  config: {
    payload: {
      title: "Foo bar",
    },
  },
});

It will be passed to the custom method from the dataProvider as a parameter. It can be used to send the sort query parameters of the request.

useCustom({
  config: {
    sort: [
      {
        field: "title",
        order: "asc",
      },
    ],
  },
});

It will be passed to the custom method from the dataProvider as a parameter. It can be used to send the filter query parameters of the request.

useCustom({
  config: {
    filters: [
      {
        field: "title",
        operator: "contains",
        value: "Foo",
      },
    ],
  },
});

queryOptions is used to pass additional options to the useQuery hook. It is useful when you want to pass additional options to the useQuery hook.

Refer to the useQuery documentation for more information →

useCustom({
  queryOptions: {
    retry: 3,
    enabled: false,
  },
});

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.

useCustom({
  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.

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

NotificationProvider is required for this prop to work.

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

useCustom({
  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, useCustom will call open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

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