Antfarm constructor
Antfarm options
Factory method which returns an AutoFolderNest. If the auto managed directory does not exist, it is created.
Path of the folder as a string or an array of strings as path segments.
af.createAutoFolderNest("outfolder")
// /Users/dominick/My Automanaged Directory/outfolder
af.createAutoFolderNest(["proofing", "others"])
// /Users/dominick/My Automanaged Directory/proofing/others
Factory method which returns a FolderNest.
Path of the folder.
Optional boolean flag to allow creation of folder if it does not exist.
Factory method which returns an FtpNest.
Hostname or IP address of the FTP server.
Port number of the FTP server.
FTP account username.
FTP account password.
Frequency of re-checking FTP in minutes.
Factory method which returns a Tunnel.
Factory method which returns a WebhookNest.
The path which is generated in the webhook's route. You can supply a string or array of strings.
HTTP method for this webhook. Choose "all" for any HTTP method.
Optional callback function to handle the request, for sending a custom response.
var webhook = af.createWebhookNest(["proof", "create"], "post");
var webhook = af.createWebhookNest(["proof", "create"], "post", function(req, res, job, nest){
res.setHeader("Content-Type", "application/json; charset=utf-8");
res.end(JSON.stringify({
job_name: job.getName(),
job_id: job.getId(),
message: "Proof created!"
}));
});
Load an entire directory of workflow modules.
Path to the workflow modules.
Generated using TypeDoc
Expose
Antfarm
.