Interface LogicalFieldExperimental

interface LogicalField {
    constraints: FieldConstraintState;
    defaultValue?: JsonValue;
    description?: string;
    domain: FieldValueDomain;
    extensions?: Readonly<Record<`${string}.${string}`, JsonValue>>;
    mutability:
        | "unknown"
        | "read-only"
        | "read-write"
        | "write-once";
    name: string;
    native: readonly NativeTypeReference[];
    nullability: "unknown" | "nullable" | "non-nullable";
    path: NonEmptyReadonlyArray<string>;
    roles: readonly FieldRole[];
    title?: string;
    type: LogicalType;
}

Properties

constraints defaultValue? description? domain extensions? mutability name native nullability path roles title? type

Properties

Readonly Experimentalconstraints

constraints: FieldConstraintState

Optional Readonly ExperimentaldefaultValue

defaultValue?: JsonValue

Optional Readonly Experimentaldescription

description?: string

Readonly Experimentaldomain

domain: FieldValueDomain

Optional Readonly Experimentalextensions

extensions?: Readonly<Record<`${string}.${string}`, JsonValue>>

Readonly Experimentalmutability

mutability:
    | "unknown"
    | "read-only"
    | "read-write"
    | "write-once"

Readonly Experimentalname

name: string

Readonly Experimentalnative

native: readonly NativeTypeReference[]

Readonly Experimentalnullability

nullability: "unknown" | "nullable" | "non-nullable"

Readonly Experimentalpath

path: NonEmptyReadonlyArray<string>

Absolute native path from the source-record root. Struct descendants strictly extend their parent's path. Paths are unique among fields that can be addressed at the same time; mutually exclusive union branches may reuse one native path.

Readonly Experimentalroles

roles: readonly FieldRole[]

Optional Readonly Experimentaltitle

title?: string

Readonly Experimentaltype

type: LogicalType

Settings

Member Visibility

On This Page

Properties