textics-stream
v1.0.0
Published
Node Text Statistics For Streams
Downloads
15
Maintainers
Readme
textics-stream
text/ics-stream
is a node version of textics. Counts lines, words, chars and spaces for a stream of strings :shower:
npm install textics-stream
API
import TStream from "textics-stream";
const txtStream = new TStream();
// Start counting
myStream.pipe(txtStream);
// Get lat chunk stat result
txtStream.on("latChunkStat", result => {
// result : {lines, words, chars, spaces}
});
// Get all stat counters
txtStream.getStat();
Example
import TStream from "textics-stream";
import fs from "fs";
// Create read stream for file you want to read form
const rStream = fs.createReadStream(myFile);
// Create TexticsStream instance
const txtStream = new TStream();
// Pass reading stream to textics
rStream.pipe(txtStream);
// For each chunk passed, give me the result
txtStream.on("latChunkStat", result => {
// do something
});
// When done, give me the final result
rStream.on("end", () => {
const { lines, words, chars, spaces } = txtStream.getStat();
});
Related projects
textics - Using textics for browser.
packageSorter - Sorting packages for monorepos production.
builderz - Building your project with zero config.
corename - Extracts package name.
get-info - Utility functions for projects production.
move-position - Moves element in given array form index-A to index-B
Tests
npm test
License
This project is licensed under the GPL-3.0 License