TaskDescription

TaskDescription contains information describing a task performed by the bag Validator. This object is emitted with the Validator's 'task' event and may be useful for logging, debugging, and updating a a GUI so the user knows the Validator is still working.

Constructor

new TaskDescription(path, op, message)

Constructor returns a new TaskDescription.

Parameters:

Name	Type	Description
`path`	string	Relative path to the file that the validator is currently working on, or absolute path to the bag being validated if we're describing a bag-level event.
`op`	string	The operation being performed on the file at relPath.
`message`	string	A message suitable for logging or displaying to the user.

Source:

bagit/task_description.js, line 8

Members

msg :string

A message suitable for logging or displaying to the user.

Source:

bagit/task_description.js, line 43

op :string

The operation being performed on the file at relPath.

Source:

bagit/task_description.js, line 37

path :string

Relative path to the file that the validator is currently working on, or absolute path to the bag being validated if we're describing a bag-level event.

Source:

bagit/task_description.js, line 31

percentComplete :string

The percent complete of the entire operation, expressed as a number between 0 and 100. This will be set only when the operation is 'checksum'.

Source:

bagit/task_description.js, line 51