@xutl/istream
v1.0.2
Published
Iterable Stream Utilities
Downloads
5
Readme
@xutl/istream
One eXtremely Useful Tool Library to wrap EventEmitter
and ReadableStream
to return an AyncIterable
. Very useful for reading files line by line or iterating over events.
Install
npm install --save-dev @xutl/istream
Usage
import { events } from '@xutl/istream';
for await (let msg of events(process, 'message', 'disconnect')) {
console.log('Received Message:', msg);
}
import { buffers } from '@xutl/istream';
for await (let buffer of buffers(process.stdin)) {
console.log('Received Buffer:', buffer);
}
import { strings } from '@xutl/istream';
for await (let string of strings(process.stdin)) {
console.log('Received String:', string);
}
import { lines } from '@xutl/istream';
for await (let line of lines(process.stdin)) {
console.log('Received Line:', lines);
}
License
Copyright 2019,2020 xutl.es
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.