Function parseTaskEmojiFormat

  • parseTaskEmojiFormat(text: string): DeepPartial<Task>

    Parses task metadata from a markdown string using Obsidian Task's emoji format.

    The function extracts the task description (the text preceding the first emoji symbol) and associated metadata. Recognized emoji markers denote fields such as cancellation, creation, completion dates, priority, or dependencies.

    For example:

    "Prepare slides ❌ 2025-05-01 ➕ 2025-04-20 ✅ 2025-05-05"
    // Returns an object similar to:
    // {
    //   description: "Prepare slides",
    //   cancelled: DateTime for "2025-05-01",
    //   created: DateTime for "2025-04-20",
    //   done: DateTime for "2025-05-05"
    // }

    Parameters

    • text: string

      The markdown text containing the task description and metadata formatted with Obsidian Task's emoji syntax.

    Returns DeepPartial<Task>

    A partial Task object populated with the extracted metadata.

    See

    https://publish.obsidian.md/tasks/Reference/Task+Formats/Tasks+Emoji+Format

Settings

Member Visibility