syncsplit(matcher, mapper, options)
Break up a stream and reassemble it so that each line is a chunk.
syncsplit
is inspired by @dominictarr split
module
and by mine split2
module, and it is totally API compatible with it.
However, it is based on syncthrough
it is fully synchronous.
matcher
may be a String
, or a RegExp
. Example, read every line in a file ...
fs
split
takes the same arguments as string.split
except it defaults to '/\r?\n/' instead of ',', and the optional limit
paremeter is ignored.
String#split
split
takes an optional options object on it's third argument, which
is directly passed as a
Transform
option.
Additionally, the .maxLength
option is implemented, which will make the split stream throw an error
if the buffer size exceeds .maxLength
.
Calling .destroy
will make the stream emit close
. Use this to perform cleanup logic
var {var file = fsreturn file}var stream =stream // will destroy the input file stream
NDJ - Newline Delimited Json
syncsplit
accepts a function which transforms each line.
fs
License
Copyright (c) 2017, Matteo Collina hello@matteocollina.com
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.