Sanity Library Reference Docs
    Preparing search index...

    Function isTodoListEntry

    • A todoList-shaped array entry: the sugar's fixed of declares label + status rows, which tells a todo list apart from other array kinds (e.g. the notes sugar's {body, actor, at}). Accepts both vocabularies — a deployed definition entry (type) and a resolved instance entry (_type) — so start-time and runtime surfaces share one verdict. The resolved-entry overload comes last: contextual typing reads an overloaded argument's FINAL signature, which .filter(isTodoListEntry) needs.

      Parameters

      Returns entry is {
          description?: string;
          editable?: Editable;
          group?: string[];
          initialValue?:
              | { type: "input" }
              | { query: string; type: "query" }
              | { type: "literal"; value: unknown }
              | {
                  field: string;
                  path?: string;
                  scope?: "workflow" | "stage";
                  type: "fieldRead";
              };
          name: string;
          required?: boolean;
          title?: string;
      } & {
          fields?: FieldShape[];
          of?: FieldShape[];
          options?: ChoiceOptions;
          roles?: 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;
      } & { type: "array" }

    • A todoList-shaped array entry: the sugar's fixed of declares label + status rows, which tells a todo list apart from other array kinds (e.g. the notes sugar's {body, actor, at}). Accepts both vocabularies — a deployed definition entry (type) and a resolved instance entry (_type) — so start-time and runtime surfaces share one verdict. The resolved-entry overload comes last: contextual typing reads an overloaded argument's FINAL signature, which .filter(isTodoListEntry) needs.

      Parameters

      Returns entry is {
          _key: string;
          _type: "array";
          description?: string;
          name: string;
          options?: ChoiceOptions;
          resolvedAt?: string;
          title?: string;
          validation?: ScalarValidation;
          value: Record<string, unknown>[];
      } & Record<never, never> & { of: FieldShape[] }

    Settings

    Member Visibility