todo-txt-cli
Version:
A CLI for todo.txt files - http://todotxt.org/
42 lines (41 loc) • 1.11 kB
TypeScript
/**
* @typedef {import('#adapter.js').Adapter} Adapter
*/
/**
* @implements {Adapter}
*/
export class FileAdapter implements Adapter {
/**
* @param {object} [options]
* @param {string} options.todoDir directory to use
* @param {string} [options.todoFile] todo.txt file
* @param {string} [options.doneFile] done.txt file
* @param {boolean} [options.doBackup=true] create a backup
*/
constructor(options?: {
todoDir: string;
todoFile?: string | undefined;
doneFile?: string | undefined;
doBackup?: boolean | undefined;
});
todoFile: string;
doneFile: string;
doBackup: boolean;
todoDir: string;
/**
* @returns {Promise<Tasks|undefined>}
*/
load(): Promise<Tasks | undefined>;
/**
* @param {Tasks} tasks
* @returns {Promise<void>}
*/
store(tasks: Tasks): Promise<void>;
/**
* @param {Tasks} tasks
* @returns {Promise<void>}
*/
archive(tasks: Tasks): Promise<void>;
}
export type Adapter = import("#adapter.js").Adapter;
import { Tasks } from '#tasks.js';