payload
Version:
Node, React and MongoDB Headless CMS and Application Framework
66 lines • 2.19 kB
TypeScript
import type { TFunction } from 'i18next';
import type { User } from '../../../../../auth';
import type { SanitizedConfig } from '../../../../../config/types';
import type { Field as FieldSchema } from '../../../../../fields/config/types';
import type { Data, Fields } from '../types';
import type { AddFieldStatePromiseArgs } from './addFieldStatePromise';
type Args = {
/**
* if any parents is localized, then the field is localized. @default false
*/
anyParentLocalized?: boolean;
/**
* config is only needed for validation
*/
config?: SanitizedConfig;
data: Data;
fields: FieldSchema[];
filter?: (args: AddFieldStatePromiseArgs) => boolean;
/**
* Force the value of fields like arrays or blocks to be the full value instead of the length @default false
*/
forceFullValue?: boolean;
fullData: Data;
id?: number | string;
/**
* Whether the field schema should be included in the state. @default false
*/
includeSchema?: boolean;
/**
* operation is only needed for checking field conditions
*/
locale: string;
/**
* Whether to omit parent fields in the state. @default false
*/
omitParents?: boolean;
/**
* operation is only needed for validation
*/
operation: 'create' | 'update';
parentPassesCondition?: boolean;
/**
* The initial path of the field. @default ''
*/
path?: string;
preferences?: {
[key: string]: unknown;
};
/**
* Whether to skip checking the field's condition. @default false
*/
skipConditionChecks?: boolean;
/**
* Whether to skip validating the field. @default false
*/
skipValidation?: boolean;
state?: Fields;
t: TFunction;
user: User;
};
/**
* Flattens the fields schema and fields data
*/
export declare const iterateFields: ({ id, anyParentLocalized, config, data, fields, filter, forceFullValue, fullData, includeSchema, locale, omitParents, operation, parentPassesCondition, path, preferences, skipConditionChecks, skipValidation, state, t, user, }: Args) => Promise<void>;
export {};
//# sourceMappingURL=iterateFields.d.ts.map