Interface FormatObjectFieldsOptions

interface FormatObjectFieldsOptions {
    formatCallback?: ((fieldValue:
        | string
        | number
        | Date
        | PageData[], fieldName: string, objectFields: FieldValues, fieldMetadata: StoredObjectFieldDTO) => void);
    skipFormatBooleans?: boolean;
    skipFormatReferenceData?: boolean;
    skipFormatUserGroups?: boolean;
}

Properties

formatCallback? skipFormatBooleans? skipFormatReferenceData? skipFormatUserGroups?

Properties

OptionalformatCallback

formatCallback?: ((fieldValue:
    | string
    | number
    | Date
    | PageData[], fieldName: string, objectFields: FieldValues, fieldMetadata: StoredObjectFieldDTO) => void)

A function that will be the last thing called in order to format the object's field values.

Type declaration

    • (fieldValue, fieldName, objectFields, fieldMetadata): void

    • Parameters

      • fieldValue:
            | string
            | number
            | Date
            | PageData[]

        the current value of the field being formatted.

      • fieldName: string

        the name of the field currently being formatted.

      • objectFields: FieldValues

        all of the available fields in the object.

      • fieldMetadata: StoredObjectFieldDTO

        the current field's metadata.

      Returns void

OptionalskipFormatBooleans

skipFormatBooleans?: boolean

OptionalskipFormatReferenceData

skipFormatReferenceData?: boolean

OptionalskipFormatUserGroups

skipFormatUserGroups?: boolean

Settings

Member Visibility

On This Page

Properties