createFunction API

Provide backend function that loads data on the page.

Import

import { createFunction } from '@toolpad/studio/server';

Description

export const myApi = createFunction(config, resolver);

Make any backend data available to your page with the createFunction. Define a named export, initialized with createFunction in toolpad/resources/functions.ts. After doing so, the function will be available when creating a Custom Function query on the page. The result of calling this function on the backend will be available as page state.

You can define parameters to bind to page state. The actual values for these parameters will be supplied when the function is called to load the data.

Parameters

resolver a function that returns data. The data will be made available on the page as soon as it loads.
config An object describing the capabilities of this backend function within Toolpad Studio. See FunctionConfig

Returns

a function that is recognizable by Toolpad Studio

Types

FunctionConfig

This describes the behavior of the custom function.

Properties

Name	Type	Description
`parameters?`	`{ [name: string]: ParameterDefinition }`	Describes the parameters that will be passed in the `parameters` property of the function. See ParameterDefinition.

ParameterDefinition

this describes the type of the parameter that will be passed to the custom function.