To segment a set of chunks from strings or streams
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

Segmenter for NodeJS

Build Status

To segment a set of chunks from strings or streams

Contributors

Installation

With npm do:

$ npm install segmenter

Examples

With string

    var Segmenter = require('segmenter'),
    seg = new Segmenter({ delimiter: "." });

    seg.fetch('a.b.c.');

Output:

[ 'a', 'b', 'c' ]

With buffer

    var seg = new Segmenter(),
        readStream = require('fs').createReadStream('dataset.txt'),
        res = [];

    readStream.on('data', function (chunk) {
        res = res.concat(seg.fetch(chunk));
    });
    readStream.on('end', function () {
        console.log('Array of lines', lines);
    });

Output:

[ 'Line 1', 'Line 2', 'etc.', ... ]

Tests

Use mocha to run the tests.

$ npm install mocha
$ mocha test

API Documentation

new Segmenter(Object options) : Object

Create the object.

Options are :

  • delimiter - String : Char or String that separe the segments. Default : \n

fetch(String chunk) : Array

Fetch segments in a String.

fetch(Buffer chunk, [String encoding]) : Array

Fetch segments in a Buffer.

Also

License

MIT/X11

Bitdeli Badge