Sanity Library Reference Docs
    Preparing search index...

    Interface FieldValueMap

    interface FieldValueMap {
        actor: Actor | null;
        array: Record<string, unknown>[];
        assignee: Assignee[];
        assignees: Assignee[];
        boolean: boolean | null;
        date: string | null;
        datetime: string | null;
        "doc.ref": GlobalDocumentReference<string> | null;
        "doc.refs": GlobalDocumentReference<string>[];
        dueDate: string | null;
        dueDatetime: string | null;
        number: number | null;
        object: Record<string, unknown> | null;
        progress: number | null;
        "release.ref": ReleaseRef | null;
        string: string | null;
        subject: GlobalDocumentReference<string> | null;
        text: string | null;
        url: string | null;
    }
    Index

    Properties

    actor array assignee assignees boolean date datetime doc.ref doc.refs dueDate dueDatetime number object progress release.ref string subject text url

    Properties

    actor: Actor | null
    array: Record<string, unknown>[]

    An array of objects, each shaped by the kind's declared of sub-fields.

    assignee: Assignee[]

    Assignment members with at most one user; role members do not consume that cardinality.

    assignees: Assignee[]
    boolean: boolean | null
    date: string | null

    Date-only (YYYY-MM-DD), no time component.

    datetime: string | null

    ISO-8601 timestamp.

    "doc.ref": GlobalDocumentReference<string> | null
    "doc.refs": GlobalDocumentReference<string>[]
    dueDate: string | null

    THE due date of a level — same value as FieldValueMap.date.

    dueDatetime: string | null

    THE due datetime of a level — same value as FieldValueMap.datetime.

    number: number | null
    object: Record<string, unknown> | null

    An object with named sub-fields; the value is keyed by sub-field name.

    progress: number | null

    Application-defined 0–100 completion — same stored value as FieldValueMap.number, distinct kind so surfaces can elevate it; always finite and within 0–100 inclusive (fractions allowed).

    "release.ref": ReleaseRef | null
    string: string | null
    subject: GlobalDocumentReference<string> | null

    THE document the workflow is about — same value as FieldValueMap."doc.ref", distinct kind so the runtime and UI identify the subject deterministically (workflow scope, at most one).

    text

    text: string | null

    Multiline string — same value as FieldValueMap.string, distinct kind for rendering.

    url: string | null

    Settings

    Member Visibility

    On This Page

    Properties