Skip to main content

BeforeDataSourceRequestFunction()

BeforeDataSourceRequestFunction: (params) => Promise<object>

Modify query to change how data is fetched from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.

Parameters

ParameterType
paramsobject
params.adminUserAdminUser
params.adminforthIAdminForth
params.extraobject
params.extra.bodyany
params.extra.cookiesRecord<string, string>
params.extra.headersRecord<string, string>
params.extra.queryRecord<string, string>
params.extra.requestUrlstring
params.filtersToolsany
params.queryany
params.resourceAdminForthResource

Returns

Promise<object>

error?

optional error: string | null

newRecordId?

optional newRecordId: string

Deprecated

Since 1.2.9. Will be removed in 2.0.0. Use redirectToRecordId instead.

ok

ok: boolean

redirectToRecordId?

optional redirectToRecordId: string