Get the _basename.
Get the directory _name.
Get the extension.
Get all _files associated with the job.
Get the ID.
Check if job is locally available.
Set if the job is locally available.
Gets the job _name.
Get the _name proper.
Get the _path.
Set a new _path.
Add a file object to the job.
Get the number of _files in this folder.
Creates file objects for folder contents. Async operation returns a callback on completion.
Create a new life event.
Sends an email.
Email options
// my_tunnel.js
tunnel.run(function (job, nest) {
job.email({
subject: "Test email from pug template",
to: "john.smith@example.com",
template: __dirname + "./template_files/my_email.pug"
});
});
// template_files/my_email.pug
h1="Example email!"
p="Got job ID " + job.getId()
tunnel.run(function (job, nest) {
job.email({
subject: "Test email with hard-coded plain-text",
to: "john.smith@example.com",
text: "My email body!"
});
});
tunnel.run(function (job, nest) {
job.email({
subject: "Test email with hard-coded html",
to: "john.smith@example.com",
html: "<h1>My email body!</h1>"
});
});
Function to call to fail a job while in a tunnel.
Get a file object from the job.
Get the job object as JSON with circular references removed.
Get the entire job property object.
Get the type of a property.
job.setPropertyValue("My Job Number", 123456);
console.log(job.getPropertyType("My Job Number"));
// "number"
Get the value of a property if it has been previously set.
Check if job is a file.
Check if job is a folder.
Add a message to the log with this job as the actor.
0 = debug, 1 = info, 2, = warning, 3 = error
Log message
Packs the job instance and file together in a zip. Returns a PackJob in the parameter of the callback.
job.pack(function(packJob){
packJob.move(packed_folder_nest);
});
Renames the job folder, leaving its content's names alone.
Attach job specific data to the job instance.
job.setPropertyValue("My Job Number", 123456);
console.log(job.getPropertyValue("My Job Number"));
// 123456
Class _name for logging.
Transfer a job to another tunnel directly.
Unpacks a packed job. Returns a the original unpacked job in the parameter of the callback.
packedJob.unpack(function(unpackedJob){
console.log("Unpacked", unpackedJob.name);
unpackedJob.move(unpacked_folder);
packedJob.remove();
});
Generated using TypeDoc
FolderJob constructor