@honua/sdk-js
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    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>

    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.

    roles: readonly FieldRole[]
    title?: string
    type: LogicalType

    Settings

    Member Visibility

    On This Page

    Properties