Field Definition

FieldDefinition is not an API, but a type. It should match the field object generated by Appframe in application static scripts.

Only name is required, but it usually a good idea to at least specify type and nullable as well.

export declare type FieldDefinition = {
    aliasName?: string;
    aggregate?: string;
    caption?: string | undefined;
    computed?: boolean;
    description?: string;
    format?: string;
    hasDefault?: boolean;
    identity?: boolean;
    ignored?: boolean;
    joined?: boolean;
    maxLength?: number;
    name: string;
    nullable?: boolean;
    type?: string;
};

Last updated

Was this helpful?