api

back to hoodie-task-server

hoodie-task-server/api

API to manage tasks.

After registering the @hoodie/task-server hapi plugin, the Task API becomes available at server.plugins.task.api, so for example to close a task with a plugin, use server.plugins.task.api.success(taskDoc) It can also be required directly.

Example

var PouchDB = require('pouchdb')
var task = require('@hoodie/task-server/api')(PouchDB)

API

• Factory
• Task.success()
• Task.progress()
• Task.error()
• Events

// all methods return promises
task.success(taskDoc, /*optional*/ data) // data is automatically set as additional property of the task doc
task.progress(taskDoc, /* optional */ data) // data is automatically merged with defaults to push a progress state into the task doc
task.error(taskDoc, error)

// events
task.on('add', function(object, options) {})
task.on('update', function(object, options) {})
task.on('remove', function(object, options) {})
task.on('change', function(eventName, object, options) {})
task.one(eventName, eventHandlerFunction)
task.off(eventName, eventHandlerFunction)