0.1.3 • Published 6 years ago

tasks-a2dev v0.1.3

Weekly downloads
2
License
ISC
Repository
github
Last release
6 years ago

tasks-a2dev

this class controll tasks in one file or not.

  • tasks created by multi task
  • task is one line.
  • taskStatus is task's status

usage

const TASKS_PATH = "/path/to/tasksfile.txt"

// create tasks and end task 2
var {Tasks, Task, TaskStatus, TaskStatusConfig} = require("tasks-a2dev")
var tasks = new Tasks(null, {file: TASKS_PATH})
tasks.add(new Task("this is my task1"))
tasks.add(new Task("this is my task2"))
tasks.get(1).status.end() // get by index

// write to file
tasks.write()

// load from file
var tasks2 = tasks.load(null, {file: TASKS_PATH})
tasks2.load()

// get string by Tasks
tasks2.toString // '[s]this is my task1\n[o]this is my task2\n'

classes

  • Tasks
  • Task
  • TaskStatus
  • TasksConfig
  • TaskConfig
  • TaskStatusConfig

Tasks methods

load (options = {})

tasks.load()

reload ()

reload task datas from setting files.

tasks.reload()

parseByFile (file)

tasks.parseByFile()

parseText (text, config = null) Tasks

get Tasks instance from tasks text.

Tasks.parseText()

toString ()

get text. it's convert from tasks.

Tasks.toStriing

add (task)

add task

tasks.add(task)

concat (tasks)

add tasks to tasks.

var tasks1 = new Tasks(null)
tasks.add(new Task("this is my task1"))
tasks.add(new Task("this is my task2"))

var tasks2 = new Tasks(null, {file: TASKS_PATH})
tasks2.concat(tasks1)

addByText (text)

add tasks from text

tasks.addByText("[s]this is my task new")

indexOfExists () boolean

get first task it's not end

tasks.indexOfExists()

get (i) Task

get Task By index

tasks.get(0)

clear ()

clear tasks

tasks.clear()

write ()

write tasks to file.

tasks.write()

NOTE: save path setting is Tasks config.file

indexOfSearch (pattern, options = {}) Task

get index of task it's search task's text by pattern.

tasks.indexOfSearch("task2")

Task methods

createByString (str, config) Task

create task by string.

Task.createByString("[s]task1")

statusInfoByStr (str, config) Task

Task.statusInfoByStr("[e]task1")

TaskStatus methods

toString ()

get string from status

task.status.toString()

start ()

change status to start

task.status.start()

end ()

change status to end

task.status.end()

error ()

change status to error

task.status.end()

update (status)

change status to update

task.status.update("myStatus")

NOTE: status can change any value.