Class Item

Represents a single line in a todo.txt file.

Constructors

constructor

new Item(line: string): Item
Parameters
- line: string
Returns Item
- Defined in Item.ts:113

Methods

addContext

addContext(tag: string): void
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
- Defined in Item.ts:399

addExtension

addExtension(key: string, value: string): void
Parameters
- key: string
- value: string
Returns void
- Defined in Item.ts:502

addProject

addProject(tag: string): void
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
- Defined in Item.ts:438

body

body(): string
Get the body of the task.

Returns string
The body portion of the task.
- Defined in Item.ts:363

clearCompleted

clearCompleted(): void
Remove the completed date from the task.

Returns void
- Defined in Item.ts:355

clearCreated

clearCreated(): void
Remove the created date from the task.

Side Effect

Clearing the created date will also unset the completed date.

Returns void
- Defined in Item.ts:306

clearPriority

clearPriority(): void
Remove the priority from this task.

Returns void
- Defined in Item.ts:257

complete

complete(): boolean
Is this task complete?

Returns boolean
- Defined in Item.ts:211

completed

completed(): Date | null
Get the completed date of this task.

Returns Date | null
The completed date, or null if not set.
- Defined in Item.ts:316

completedToString

completedToString(): string
Get the completed date as string, or an empty string if not set.

Returns string
The completed date as a string formatted for todo.txt (YYYY-MM-DD)
- Defined in Item.ts:325

contexts

contexts(): string[]
Get all of the context tags on the task.

Returns string[]
Context tags, without the @
- Defined in Item.ts:389

created

created(): Date | null
Get the creation date of this task.

Returns Date | null
The creation date, or null if not set.
- Defined in Item.ts:266

createdToString

createdToString(): string
Get the creation date as string, or an empty string if not set.

Returns string
The creation date as a string formatted for todo.txt (YYYY-MM-DD)
- Defined in Item.ts:275

extensions

extensions(): { key: string; value: string }[]
Get all of the project tags on the task.

Returns { key: string; value: string }[]
Project tags, without the +
- Defined in Item.ts:467

parse

parse(line: string): void
Parse in a full todo.txt line, replacing and resetting all fields.
Parameters
- line: string
  A full todo.txt task line
Returns void
- Defined in Item.ts:122

priority

priority(): string | null
Get the priority of this Item, or null if not present.

Returns string | null
- Defined in Item.ts:234

projects

projects(): string[]
Get all of the project tags on the task.

Returns string[]
Project tags, without the +
- Defined in Item.ts:428

removeContext

removeContext(tag: string): void
Remove a context from the task, if present.
Parameters
- tag: string
  A valid context, without the @
Returns void
- Defined in Item.ts:411

removeExtension

removeExtension(key: string, value?: string | null): void
Parameters
- key: string
- value: string | null = null
Returns void
- Defined in Item.ts:507

removeProject

removeProject(tag: string): void
Remove a project from the task, if present.
Parameters
- tag: string
  A valid project, without the +
Returns void
- Defined in Item.ts:450

setBody

setBody(body: string): void
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
- Defined in Item.ts:376

setComplete

setComplete(complete: boolean): void
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
- Defined in Item.ts:224

setCompleted

setCompleted(date?: string | Date | null): void
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.
Parameters
- date: string | Date | null = null
Returns void

Throws
An Error when the date is provided as a string and is invalid.
- Defined in Item.ts:339

setCreated

setCreated(date?: string | Date | null): void
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.
Parameters
- date: string | Date | null = null
Returns void

Throws
An Error when the date is provided as a string and is invalid.
- Defined in Item.ts:289

setExtension

setExtension(key: string, value: string): void
Parameters
- key: string
- value: string
Returns void
- Defined in Item.ts:473

setPriority

setPriority(priority?: Priority): void
Set the priority of the task. Passing null or no argument clears priority.
Parameters
- priority: Priority = null
  A priority from A-Z or null to clear priority.
Returns void

Throws
An Error when the input is invalid.
- Defined in Item.ts:244

toAnnotatedString

toAnnotatedString(): AnnotatedItem
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
- Defined in Item.ts:168

toString

toString(): string
Generate a full todo.txt line out of this Item.

Returns string
- Defined in Item.ts:152