Interface Task

Represents a task with various properties.

interface Task {
    active: boolean;
    allContext: string[];
    allMeta: { [key: string]: string[] };
    allTags: string[];
    beforeText: string;
    content: string;
    context: string[];
    created: string;
    createdDate: Date;
    data: object;
    expand: boolean;
    filteredListName: string;
    frontMatter: object;
    interpretedContent: string;
    lastLine: number;
    line: number;
    list: string;
    meta: { [key: string]: string[] };
    metaKeys: string[];
    order: number;
    progress: { completed: number; total: number };
    source: {
        createdTime: string;
        ext: string;
        lang: string;
        modifiedTime: string;
        path: string;
    };
    tags: string[];
    type: "CODE"
    | "HASHTAG"
    | "MARKDOWN";
}

Properties

active allContext allMeta allTags beforeText content context created createdDate data expand filteredListName frontMatter interpretedContent lastLine line list meta metaKeys order progress source tags type

Properties

active

active: boolean

Represents the state of the task.

allContext

allContext: string[]

All context strings associated with the task.

allMeta

allMeta: { [key: string]: string[] }

All metadata associated with the task, where each key maps to an array of strings.

allTags

allTags: string[]

All tags associated with the task.

beforeText

beforeText: string

Text before the main content.

content

content: string

Main content of the task.

context

context: string[]

Context strings associated with the task.

created

created: string

Creation timestamp of the task.

createdDate

createdDate: Date

Creation date of the task as a Date object.

data

data: object

Data associated with the task. This is added by plugins and extensions, through properties.

expand

expand: boolean

Indicates whether the task is expanded in the UI.

filteredListName

filteredListName: string

Name of the filtered list if the task is in a filteredList.

frontMatter

frontMatter: object

Front matter of the file the task is in.

interpretedContent

interpretedContent: string

Interpreted content of the task, after processing.

lastLine

lastLine: number

The last line number of this task in it's file.

line

line: number

The line number of this task in it's file.

list

list: string

The list to which the current item belongs.

meta

meta: { [key: string]: string[] }

Metadata associated with the current item, where each key maps to an array of strings.

metaKeys

metaKeys: string[]

Keys of the metadata associated with the current item.

order

order: number

Order of the current item within its list.

progress

progress: { completed: number; total: number }

Progress information for the task.

Type declaration

  • completed: number

    Number of completed items.

  • total: number

    Total number of items.

source

source: {
    createdTime: string;
    ext: string;
    lang: string;
    modifiedTime: string;
    path: string;
}

Source information for the task.

Type declaration

  • createdTime: string

    Creation time of the source file.

  • ext: string

    Extension of the source file.

  • lang: string

    Language of the source file.

  • modifiedTime: string

    Last modified time of the source file.

  • path: string

    Path to the source file.

tags

tags: string[]

Tags associated with the current item.

type

type: "CODE" | "HASHTAG" | "MARKDOWN"

Type of Task.

Settings

Member Visibility

On This Page

Properties