Interface FlowObjectType<F>

Defines the structure for an object within a Flow. This type can be recursive, allowing nested object structures.

interface FlowObjectType<
    F extends Record<string, FlowValueType> = Record<string, FlowValueType>,
> {
    attributes?: Record<string, string | number | boolean>;
    fields: F;
    label: string;
    mandatory?: boolean;
}

F extends Record<string, FlowValueType> = Record<string, FlowValueType>
A record defining the fields of the object, where keys are field names and values are FlowValueType.

Properties

attributes?: Record<string, string | number | boolean>

Pairs of any supported dictionary attributes (sys_schema_attribute)

fields: F

The actual field definitions for this object.

label: string

A user-friendly label for this object type.

mandatory?: boolean

Indicates if this object instance is required.