Type Alias TaskStatus

TaskStatus:
    | { type: "UNKNOWN" }
    | { symbol: string; type: "OPEN" | "DONE" | "CANCELLED" | "NON_TASK" }

Metadata about the actionable status of a task.

Type declaration

  • { type: "UNKNOWN" }
    • type: "UNKNOWN"

      "UNKNOWN" is reserved for tasks that are invalid or unparsable.

  • { symbol: string; type: "OPEN" | "DONE" | "CANCELLED" | "NON_TASK" }
    • symbol: string

      The character inside the [ ] brackets on the line with the task.

    • type: "OPEN" | "DONE" | "CANCELLED" | "NON_TASK"

      The status of the task. Mirrors the status provided by the "obsidian-tasks" plugin.