Class Project

Represents a project with lists, tasks, and various actions.

Constructors

constructor

new Project(): Project
Returns Project

Accessors

doneList

get doneList(): string
Gets the name of the done list.

Returns string
- Defined in project.ts:117

filter

get filter(): string
Gets the current filter applied to the project.

Returns string
- Defined in project.ts:124
set filter(filter: string): void
Sets the filter for task retrieval.
Parameters
- filter: string
Returns void
- Defined in project.ts:145

filteredCards

get filteredCards(): Task[]
Gets the filtered tasks based on the current filter.

Returns Task[]
- Defined in project.ts:131

lists

get lists(): List[]
Gets all lists in the project.

Returns List[]
- Defined in project.ts:110

path

get path(): string
Gets the project path.

Returns string
- Defined in project.ts:103

updatedAt

get updatedAt(): Date
Gets the last updated timestamp.

Returns Date
- Defined in project.ts:138

Methods

addCardToFile

addCardToFile(opts: AddCardToFileOpts): Promise<AddCardToFileResponse>
Adds a card to a file and returns the created task.
Parameters
- opts: AddCardToFileOpts
Returns Promise<AddCardToFileResponse>
- Defined in project.ts:181

addContextToContent

addContextToContent(contexts: string[], content: string): string
Adds context to the provided content.
Parameters
- contexts: string[]
- content: string
Returns string
- Defined in project.ts:219

addMetadata

addMetadata(task: Task, key: string, value: string): Promise<void>
Adds metadata to a task.
Parameters
- task: Task
- key: string
- value: string
Returns Promise<void>
- Defined in project.ts:231

addMetaToContent

addMetaToContent(meta: Meta[], content: string): string
Adds metadata to the provided content.
Parameters
- meta: Meta[]
- content: string
Returns string
- Defined in project.ts:205

addTag

addTag(task: Task, tag: string): Promise<void>
Adds a tag to a task.
Parameters
- task: Task
- tag: string
Returns Promise<void>
- Defined in project.ts:241

addTagsToContent

addTagsToContent(tags: string[], content: string): string
Adds tags to the provided content.
Parameters
- tags: string[]
- content: string
Returns string
- Defined in project.ts:212

copyToClipboard

copyToClipboard(text: string, message: string): Promise<void>
Copies text to the clipboard and shows a message.
Parameters
- text: string
- message: string
Returns Promise<void>
- Defined in project.ts:261

destroy

destroy(): void
Destroys the project instance.

Returns void
- Defined in project.ts:157

filterLists

filterLists(filter: string, lists: List[]): List[]
Filters lists based on a provided filter.
Parameters
- filter: string
- lists: List[]
Returns List[]
- Defined in project.ts:188

getAllCards

getAllCards(filter?: string): Task[]
Retrieves all cards, optionally filtered.
Parameters
- Optionalfilter: string
Returns Task[]
- Defined in project.ts:162

init

init(repo: any): void
Initializes the project with a given repository.
Parameters
- repo: any
Returns void
- Defined in project.ts:152

newCard

newCard(opts: NewCardOpts): void
Creates a new card in the project.
Parameters
- opts: NewCardOpts
Returns void
- Defined in project.ts:176

openPath

openPath(filePath: string): Promise<void>
Open the given file in the desktop's default manner.
Parameters
- filePath: string
Returns Promise<void>
- Defined in project.ts:271

openUrl

openUrl(url: string): Promise<void>
Opens a URL in the default browser.
Parameters
- url: string
Returns Promise<void>
- Defined in project.ts:266

removeMetadata

removeMetadata(task: Task, key: string, value: string): Promise<void>
Removes metadata from a task.
Parameters
- task: Task
- key: string
- value: string
Returns Promise<void>
- Defined in project.ts:236

removeTag

removeTag(task: Task, tag: string): Promise<void>
Removes a tag from a task.
Parameters
- task: Task
- tag: string
Returns Promise<void>
- Defined in project.ts:246

renderMarkdown

renderMarkdown(content: string): string
Renders Markdown content as HTML.
Parameters
- content: string
Returns string
- Defined in project.ts:169

saveFile

saveFile(content: string, path: string): void
Saves content to a specified file path.
Parameters
- content: string
- path: string
Returns void
- Defined in project.ts:195

setFilter

setFilter(filter: string): void
Sets the current filter for the project.
Parameters
- filter: string
Returns void
- Defined in project.ts:200

snackBar

snackBar(alert: Alert): Promise<void>
Displays a snackbar notification.
Parameters
- alert: Alert
Returns Promise<void>
- Defined in project.ts:251

toast

toast(alert: Alert): Promise<void>
Displays a toast notification.
Parameters
- alert: Alert
Returns Promise<void>
- Defined in project.ts:256

updateCardContent

updateCardContent(task: Task, content: string): Promise<void>
Updates the content of a given task.
Parameters
- task: Task
- content: string
Returns Promise<void>
- Defined in project.ts:226