Files
ipal-kit/dist/modules/hooks/validateUniqueRole.d.ts
T

17 lines
631 B
TypeScript

import type { FieldHook } from 'payload';
/**
* Field hook for a System Page role relationship in SiteSettings: ensures a page
* isn't assigned to two roles at once (e.g. the same page as both homepage and
* privacyPolicy), which would make routing ambiguous.
*
* Attach to each role field's beforeValidate. `siblingFields` are the OTHER role
* field names to check against.
*
* hooks: { beforeValidate: [buildValidateUniqueRole({
* siblingFields: ['privacyPolicy', 'cookiePolicy', 'termsOfService'],
* })] }
*/
export declare function buildValidateUniqueRole(args: {
siblingFields: string[];
}): FieldHook;