Interface FieldDescriptor

interface FieldDescriptor {
    name: string;
    origin: FieldOrigin;
    from?: string;
    source?: SourceRef;
    fakerable: boolean;
    required: boolean;
}

Index

Properties

name origin from? source? fakerable required

Properties

name

name: string

origin

origin: FieldOrigin

`Optional`from

from?: string

the raw x-suluk-from when it is a human note (string).

`Optional`source

source?: SourceRef

the machine-wireable edge when x-suluk-from is structured { op, select? }.

fakerable

fakerable: boolean

true IFF a client may freely synthesize/fill it (origin === "input").

required

required: boolean