miniwrite
Minimal output-stream writer API.A pluggable output writer interface/adapter to embed/expose in tools and reporters, also a simplified stream. This is not a logging framework or full console or stream replacement. Instead this is an abstraction to build on or expose in other tools. Intend as companion to ministyle (et al).
API
Main usage: ````js // simplified node.js.browser compatible console.log() var mw = miniwrite.console(); // write plain text line mw.writeln('hello world!'); ````Helpers
Buffer writes: ````js // buffer own lines var mw = miniwrite.buffer(); // buffer other writes (handy for testing) var mw = miniwrite.buffer(myMiniWrite); // get buffer var str = mw.concat(); var str = mw.concat('\n\n', '\t'); // iterate buffer if you must mw.lines.forEach(function(line) {//..mw.write(chars), auto-flushes on newlines:
````js
var mw = miniwrite.chars(miniwrite.console());
// write plain text line
mw.write('hello');
mw.write(' ');
mw.writeln('world!'); // "hello world\n"
//or accumulate chars
mw.write('one');
mw.write('two');
mw.flush(true); // onetwo
// clear buffer
mw.write('one');
mw.clear();
mw.write('two');
mw.flush(true); // two
````
Spread of multiple writers
````js
var mw = miniwrite.multi(myANSIConsole, myRemoteSocket, myDiskLogger);
mw.enabled = true;
mw.targets.forEach(function(subw, num) {
// .. // return string, or false to ignoregrunt ~0.4.1):
````js
var mw = miniwrite.grunt(grunt);
````
Examples
Build your own: ````js var mw = {}; mw.writeln = function(line) {myWebSocketHyperStream.send({line: line})Installation
```shell $ npm install miniwrite --save ```History
- 0.1.2 - Enabled strict mode, split in internal modules
- 0.1.0 - Extracted styling to ministyle.
- 0.0.1 - Extracted code from existing projects
Build
Install development dependencies in your git checkout:$ npm install$ gruntGruntfile.js for additional commands.
