Files
WeihnachtsKalenderMelly/node_modules/exec-buffer/readme.md
2021-11-23 17:56:26 +01:00

1.2 KiB

exec-buffer Build Status

Run a Buffer through a child process

Install

$ npm install --save exec-buffer

Usage

var ExecBuffer = require('exec-buffer');
var fs = require('fs');
var gifsicle = require('gifsicle').path;

var execBuffer = new ExecBuffer();

execBuffer.use(gifsicle, ['-o', execBuffer.dest(), execBuffer.src()]);
execBuffer.run(fs.readFileSync('test.gif'), function (err, data) {
		if (err) {
			throw err;
		}

		console.log(data);
		//=> <Buffer 47 49 46 38 37 61 ...>
	});
});

API

new ExecBuffer()

Creates a new ExecBuffer instance.

.use(bin, args)

bin

Type: String

Path to the binary.

args

Type: Array

Arguments to run the binary with.

.src(path)

path

Type: String

Set or get the temporary source path.

.dest(path)

path

Type: String

Set or get the temporary destination path.

.run(buf, cb)

buf

Type: Buffer

The Buffer to be ran through the child process.

cb(err, data, stderr)

Type: Function

Returns a Buffer with the new data and any stderr output.

License

MIT © Kevin Mårtensson