Sanity Library Reference Docs
    Preparing search index...

    One declared field entry as authored and stored: name, value kind, and its scope's sourcing and editability.

    interface FieldEntry {
        description?: string;
        editable?: Editable;
        fields?: FieldShape[];
        group?: string[];
        initialValue?:
            | { type: "input" }
            | { query: string; type: "query" }
            | { type: "literal"; value: unknown }
            | {
                field: string;
                path?: string;
                scope?: "workflow" | "stage";
                type: "fieldRead";
            };
        name: string;
        of?: FieldShape[];
        options?: ChoiceOptions;
        required?: boolean;
        roles?: string[];
        title?: string;
        type: | "string"
        | "number"
        | "boolean"
        | "object"
        | "actor"
        | "datetime"
        | "array"
        | "text"
        | "url"
        | "doc.ref"
        | "doc.refs"
        | "subject"
        | "release.ref"
        | "progress"
        | "date"
        | "dueDate"
        | "dueDatetime"
        | "assignee"
        | "assignees";
        types?: string[];
        validation?: ScalarValidation;
    }
    Index

    Properties

    description?: string
    editable?: Editable
    fields?: FieldShape[]
    group?: string[]
    initialValue?:
        | { type: "input" }
        | { query: string; type: "query" }
        | { type: "literal"; value: unknown }
        | {
            field: string;
            path?: string;
            scope?: "workflow" | "stage";
            type: "fieldRead";
        }
    name: string
    of?: FieldShape[]
    options?: ChoiceOptions
    required?: boolean
    roles?: string[]

    Non-empty assignment eligibility constraint. User roles apply aliases; collective roles match literally.

    title?: string
    type:
        | "string"
        | "number"
        | "boolean"
        | "object"
        | "actor"
        | "datetime"
        | "array"
        | "text"
        | "url"
        | "doc.ref"
        | "doc.refs"
        | "subject"
        | "release.ref"
        | "progress"
        | "date"
        | "dueDate"
        | "dueDatetime"
        | "assignee"
        | "assignees"
    types?: string[]
    validation?: ScalarValidation