Type Alias TaskSource

TaskSource:
    | { type: "UNKNOWN" }
    | {
        lineNumber: number;
        name: string;
        obsidianHref: string;
        path: string;
        section?: string;
        startByte: number;
        stopByte: number;
        type: "PAGE";
    }

Metadata about where a task was extracted/generated from.

Type declaration

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

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

  • {
        lineNumber: number;
        name: string;
        obsidianHref: string;
        path: string;
        section?: string;
        startByte: number;
        stopByte: number;
        type: "PAGE";
    }
    • lineNumber: number

      The line of the file this task shows up on.

    • name: string

      The name of the file this task was taken from, excluding its extension.

    • obsidianHref: string

      A URL to the file that Obsidian can open and understand.

    • path: string

      The full path of the file this task was taken from.

    • Optionalsection?: string

      The section this task belongs to, if applicable.

    • startByte: number

      The byte in the file this task begins at.

    • stopByte: number

      The byte in the file this task ends at.

    • type: "PAGE"

      Identifies where this task was extracted/generated from.