Class Todo

Class representing a single todo in the todo.txt format. A todo includes completion status, priority, dates, descriptions, and metadata like projects, contexts, and key-value pairs.

Constructors

constructor

new Todo(
    options?: {
        completed?: boolean;
        completionDate?: string;
        contexts?: string[];
        creationDate?: string;
        description?: string;
        due?: string;
        keyValues?: { [key: string]: any };
        priority?: string;
        projects?: string[];
        [key: string]: any;
    },
): Todo
Creates a new Todo instance.
Parameters
- Optionaloptions: {
      completed?: boolean;
      completionDate?: string;
      contexts?: string[];
      creationDate?: string;
      description?: string;
      due?: string;
      keyValues?: { [key: string]: any };
      priority?: string;
      projects?: string[];
      [key: string]: any;
  } = {}
  Optional configuration for the new todo.
  - [key: string]: any
  - Optionalcompleted?: boolean
    Whether the todo is completed.
  - OptionalcompletionDate?: string
    When the todo was completed.
  - Optionalcontexts?: string[]
    Array of context tags starting with "@".
  - OptionalcreationDate?: string
    When the todo was created.
  - Optionaldescription?: string
    The description text.
  - Optionaldue?: string
    Due date in YYYY-MM-DD format.
  - OptionalkeyValues?: { [key: string]: any }
    Key-value metadata.
  - Optionalpriority?: string
    The priority of the todo (A-Z or in format "(A)").
  - Optionalprojects?: string[]
    Array of project tags starting with "+".
Returns Todo
- Defined in src/Todo.ts:65

Accessors

completed

get completed(): boolean
Get completed status

Returns boolean
- Defined in src/Todo.ts:160
set completed(value: boolean): void
Set completed status
Parameters
- value: boolean
Returns void
- Defined in src/Todo.ts:247

completionDate

get completionDate(): undefined | string
Get completion date

Returns undefined | string
- Defined in src/Todo.ts:170
set completionDate(value: undefined | string): void
Set the completion date
Parameters
- value: undefined | string
Returns void
- Defined in src/Todo.ts:255

contexts

get contexts(): readonly string[]
Get contexts

Returns readonly string[]
- Defined in src/Todo.ts:190

creationDate

get creationDate(): undefined | string
Get creation date

Returns undefined | string
- Defined in src/Todo.ts:175
set creationDate(value: undefined | string): void
Set the creation date
Parameters
- value: undefined | string
Returns void
- Defined in src/Todo.ts:260

description

get description(): string
Get description

Returns string
- Defined in src/Todo.ts:180

id

get id(): string
Get the unique identifier

Returns string
- Defined in src/Todo.ts:155

keyValues

get keyValues(): Readonly<{ [key: string]: any }>
Get key-value pairs

Returns Readonly<{ [key: string]: any }>
- Defined in src/Todo.ts:195

priority

get priority(): undefined | string
Get priority

Returns undefined | string
- Defined in src/Todo.ts:165

projects

get projects(): readonly string[]
Get projects

Returns readonly string[]
- Defined in src/Todo.ts:185

Methods

addContext

addContext(context: string): void
Adds a context tag to the todo.
Parameters
- context: string
  Context tag to add (with or without the @ symbol).
Returns void
- Defined in src/Todo.ts:401

addProject

addProject(project: string): void
Adds a project tag to the todo.
Parameters
- project: string
  Project tag to add (with or without the + symbol).
Returns void
- Defined in src/Todo.ts:421

clone

clone(): Todo
Creates a deep copy of this todo.

Returns Todo
A new todo with the same properties.
- Defined in src/Todo.ts:572

daysUntilDue

daysUntilDue(): undefined | number
Calculates the number of days until the todo is due.

Returns undefined | number
Number of days, or undefined if no due date.
- Defined in src/Todo.ts:349

decreasePriority

decreasePriority(): void
Decreases priority by one level (e.g., A -> B). If the priority is already Z, removes the priority.

Returns void
- Defined in src/Todo.ts:458

generateRecurringTodo

generateRecurringTodo(): undefined | Todo
Generates a new todo based on the recurrence pattern.

Returns undefined | Todo
A new todo with updated due date, or undefined if not recurring.
- Defined in src/Todo.ts:483

getDueDate

getDueDate(): undefined | string
Gets the due date of the todo, if any.

Returns undefined | string
The due date in YYYY-MM-DD format or undefined.
- Defined in src/Todo.ts:203

getRecurrence

getRecurrence(): undefined | RecurrencePattern
Gets the recurrence pattern of the todo, if any.

Returns undefined | RecurrencePattern
The recurrence pattern or undefined.
- Defined in src/Todo.ts:211

increasePriority

increasePriority(): void
Increases priority by one level (e.g., B -> A). If the todo has no priority, sets it to (Z).

Returns void
- Defined in src/Todo.ts:441

isDueToday

isDueToday(): boolean
Checks if the todo is due today.

Returns boolean
True if the todo is due today.
- Defined in src/Todo.ts:331

isOverdue

isOverdue(): boolean
Checks if the todo is overdue.

Returns boolean
True if the todo is overdue and not completed.
- Defined in src/Todo.ts:340

markCompleted

markCompleted(completionDate?: string): void
Marks the todo as completed.
Parameters
- OptionalcompletionDate: string
  Optional completion date in YYYY-MM-DD format. Defaults to today if not provided.
Returns void
- Defined in src/Todo.ts:370

markIncomplete

markIncomplete(): void
Marks the todo as incomplete, removing any completion date.

Returns void
- Defined in src/Todo.ts:378

removeContext

removeContext(context: string): void
Removes a context tag from the todo.
Parameters
- context: string
  Context tag to remove (with or without the @ symbol).
Returns void
- Defined in src/Todo.ts:412

removeKeyValue

removeKeyValue(key: string): void
Removes a key-value pair from the todo.
Parameters
- key: string
  The key name to remove.
Returns void
- Defined in src/Todo.ts:475

removeProject

removeProject(project: string): void
Removes a project tag from the todo.
Parameters
- project: string
  Project tag to remove (with or without the + symbol).
Returns void
- Defined in src/Todo.ts:432

setDescription

setDescription(newDescription: string): void
Sets the description text of the todo.
Parameters
- newDescription: string
  The new description text.
Returns void
- Defined in src/Todo.ts:268

setDueDate

setDueDate(dueDate: string): void
Sets the due date for the todo.
Parameters
- dueDate: string
  The due date in YYYY-MM-DD format.
Returns void
- Defined in src/Todo.ts:276

setKeyValue

setKeyValue(key: string, value: any): void
Sets a key-value pair on the todo.
Parameters
- key: string
  The key name.
- value: any
  The value to store.
Returns void
- Defined in src/Todo.ts:310

setPriority

setPriority(priority: null | string): void
Sets the priority of the todo.
Parameters
- priority: null | string
  Priority letter (A-Z) or null to remove priority.
Returns void
- Defined in src/Todo.ts:284

setRecurrence

setRecurrence(pattern: RecurrencePattern): void
Sets a recurrence pattern for the todo.
Parameters
- pattern: RecurrencePattern
  The recurrence pattern configuration.
Returns void
- Defined in src/Todo.ts:318

toggleCompletion

toggleCompletion(): boolean
Toggles completion status of the todo.

Returns boolean
The new completion status.
- Defined in src/Todo.ts:387

toString

toString(): string
Converts the todo to its string representation.

Returns string
The todo in todo.txt format.
- Defined in src/Todo.ts:520

Class Todo

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

[key: string]: any

Optionalcompleted?: boolean

OptionalcompletionDate?: string

Optionalcontexts?: string[]

OptionalcreationDate?: string

Optionaldescription?: string

Optionaldue?: string

OptionalkeyValues?: { [key: string]: any }

Optionalpriority?: string

Optionalprojects?: string[]

Returns Todo

Accessors

completed

Returns boolean

Parameters

Returns void

completionDate

Returns undefined | string

Parameters

Returns void

contexts

Returns readonly string[]

creationDate

Returns undefined | string

Parameters

Returns void

description

Returns string

id

Returns string

keyValues

Returns Readonly<{ [key: string]: any }>

priority

Returns undefined | string

projects

Returns readonly string[]

Methods

addContext

Parameters

Returns void

addProject

Parameters

Returns void

clone

Returns Todo

daysUntilDue

Returns undefined | number

decreasePriority

Returns void

generateRecurringTodo

Returns undefined | Todo

getDueDate

Returns undefined | string

getRecurrence

Returns undefined | RecurrencePattern

increasePriority

Returns void

isDueToday

Returns boolean

isOverdue

Returns boolean

markCompleted

Parameters

Returns void

markIncomplete

Returns void

removeContext

Parameters

Returns void

removeKeyValue

Parameters

Returns void

`Optional`completed?: boolean

`Optional`completionDate?: string

`Optional`contexts?: string[]

`Optional`creationDate?: string

`Optional`description?: string

`Optional`due?: string

`Optional`keyValues?: { [key: string]: any }

`Optional`priority?: string

`Optional`projects?: string[]