Class Item

Represents a single line in a todo.txt file.

Hierarchy

  • Item

Constructors

constructor

Properties

#body #complete #completed #contexts #created #extensions #priority #projects

Methods

addContext addExtension addProject body clearCompleted clearCreated clearPriority complete completed completedToString contexts created createdToString extensions parse priority projects removeContext removeExtension removeProject setBody setComplete setCompleted setCreated setExtension setPriority toAnnotatedString toString

Constructors

constructor

Properties

Private #body

#body: string = ''

Private #complete

#complete: boolean = false

Private #completed

#completed: null | Date = null

Private #contexts

#contexts: TrackedTag[] = []

Private #created

#created: null | Date = null

Private #extensions

#extensions: TrackedExtension[] = []

Private #priority

#priority: Priority = null

Private #projects

#projects: TrackedTag[] = []

Methods

addContext

  • Add a new context to the task. Will append to the end. If the context is already present, it will not be added.

    Parameters

    • tag: string

      A valid context, without the @

    Returns void

addExtension

  • Parameters

    • key: string
    • value: string

    Returns void

addProject

  • Add a new project to the task. Will append to the end. If the project is already present, it will not be added.

    Parameters

    • tag: string

      A valid project, without the +

    Returns void

body

  • Get the body of the task.

    Returns

    The body portion of the task.

    Returns string

clearCompleted

  • Remove the completed date from the task.

    Returns void

clearCreated

  • Remove the created date from the task.

    Side Effect

    Clearing the created date will also unset the completed date.

    Returns void

clearPriority

  • Remove the priority from this task.

    Returns void

complete

  • Is this task complete?

    Returns boolean

completed

  • Get the completed date of this task.

    Returns

    The completed date, or null if not set.

    Returns null | Date

completedToString

  • Get the completed date as string, or an empty string if not set.

    Returns

    The completed date as a string formatted for todo.txt (YYYY-MM-DD)

    Returns string

contexts

  • Get all of the context tags on the task.

    Returns

    Context tags, without the @

    Returns string[]

created

  • Get the creation date of this task.

    Returns

    The creation date, or null if not set.

    Returns null | Date

createdToString

  • Get the creation date as string, or an empty string if not set.

    Returns

    The creation date as a string formatted for todo.txt (YYYY-MM-DD)

    Returns string

extensions

  • Get all of the project tags on the task.

    Returns

    Project tags, without the +

    Returns {
        key: string;
        value: string;
    }[]

parse

  • Parse in a full todo.txt line, replacing and resetting all fields.

    Parameters

    • line: string

      A full todo.txt task line

    Returns void

priority

  • Get the priority of this Item, or null if not present.

    Returns null | string

projects

  • Get all of the project tags on the task.

    Returns

    Project tags, without the +

    Returns string[]

removeContext

  • Remove a context from the task, if present.

    Parameters

    • tag: string

      A valid context, without the @

    Returns void

removeExtension

  • Parameters

    • key: string
    • value: null | string = null

    Returns void

removeProject

  • Remove a project from the task, if present.

    Parameters

    • tag: string

      A valid project, without the +

    Returns void

setBody

  • Parse and set the body and body elements.

    Side Effect

    This will clear and re-load contexts, projects and extensions.

    Parameters

    • body: string

      A todo.txt description string.

    Returns void

setComplete

  • Set if this task is complete.

    Side Effect

    Setting this to false will clear the completed date.

    Parameters

    • complete: boolean

      True if the task is complete.

    Returns void

setCompleted

  • Set the completed date for the task. Passing null or no argument clears the completed date.

    Side Effect

    Setting completed will set complete to true.

    Throws

    An Error when the date is provided as a string and is invalid.

    Throws

    An Error when the created date is not set.

    Parameters

    • date: null | string | Date = null

    Returns void

setCreated

  • Set the created date for the task. Passing null or no argument clears the created date.

    Side Effect

    Clearing the created date will also unset the completed date.

    Throws

    An Error when the date is provided as a string and is invalid.

    Parameters

    • date: null | string | Date = null

    Returns void

setExtension

  • Parameters

    • key: string
    • value: string

    Returns void

setPriority

  • Set the priority of the task. Passing null or no argument clears priority.

    Throws

    An Error when the input is invalid.

    Parameters

    • priority: Priority = null

      A priority from A-Z or null to clear priority.

    Returns void

toAnnotatedString

  • Generate the full todo.txt line of this Item, as well as spans describing the location of all of it's component parts.

    Returns AnnotatedItem

toString

  • Generate a full todo.txt line out of this Item.

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc