Options
All
  • Public
  • Public/Protected
  • All
Menu

Antfarm 🐜

antfarm

Antfarm is a simple automation framework that aims to make file automation robust and scalable. 🐜

Build Status Coverage Status npm version Dependancy Status Gitter

Usage

$ npm install antfarm
const   Antfarm = require('antfarm'),
        af = new Antfarm();

let hotfolder_a = af.createFolderNest("/var/hotfolders/a");
let pdf_folder = af.createFolderNest("/var/out/pdf");
let other_folder = af.createFolderNest("/var/out/others");

let tunnel = af.createTunnel("Simple pdf sorting workflow");

tunnel.watch(hotfolder_a);

tunnel.run((job, nest) => {
    if(job.extension == "pdf"){
        job.move(pdf_folder);
    } else {
        job.move(other_folder);
    }
});

Documentation warning

During late October, much of antfarm was refactor to use TypeScript's accessors. The documentation may be out of date.

// Old style
job.setName("myFile.pdf");
console.log(job.getName());

// New style, using TypeScript accessors
job.name = "myFile.pdf";
console.log(job.name);

Wiki

https://github.com/dominickp/antfarm/wiki

API Reference

https://dominickp.github.io/antfarm

Generated using TypeDoc