$ npm install base-files-process
Plugin for processing files from a declarative configuration.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm install --save base-files-process
var files = require('base-files-process');
var Base = require('base-app');
var expand = require('expand-files');
var pipeline = require('base-pipeline');
var files = require('base-files-process');
var app = new Base();
app.use(pipeline());
app.use(files());
// register pipeline plugins using the `.plugin` method
app.plugin('foo', function(options) {
return through.obj(function(file, enc, next) {
// do plugin stuff
next(null, file);
});
});
// use `expand-files` to expand a declarative configuration object
var config = expand({
cwd: fixtures,
src: '*.txt',
dest: actual
});
// pass the config object to `.processFiles()`
app.processFiles(config)
.on('end', function() {
console.log('done!');
});
Process an array of files objects, where each object has a src and dest property.
Params
files {Array}options {Object}returns {Stream}Example
var expand = require('expand-files');
var config = expand({
cwd: fixtures,
src: 'b.txt',
dest: actual
});
app.processFiles(config)
.on('error', console.log)
.on('end', console.log);
Breaking changes
.process method to .processFilesPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on July 18, 2016.