npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

streaming-markov-chain-builder

v1.0.1

Published

A Markov chain builder that accepts input text as a stream and outputs a stream of n-grams.

Downloads

6

Readme

streaming-markov-chain-builder

Gitlab pipeline status (self-hosted) npm bundle size npm

streaming-markov-chain-builder is a Markov chain builder that accepts input text as a stream and outputs a stream of n-grams.

Installation

npm i --save streaming-markov-chain-builder

Usage

const { MarkovBuilder } = require('streaming-markov-chain-builder')

const builder = MarkovBuilder({
  // number of "context words" to add to each individual word
  // defaults to 1
  order: 1

  // optional - return true if this `word` should be considered 'proper'
  // see `src/is-proper.ts` for the default implementation, exported as { isProperFn }
  isProperFn: (word) => { return _.isUpperCase(word[0]) }

  // optional - given a single line, return a list of sub-sentences
  // see `src/sentence-splitter.ts` for the default implementation, exported as { sentenceSplitterFn }
  sentenceSplitterFn: (line) => { return line.split(/[\.\?!]/g) }
})

// now, you can start ingesting data by writing it...
builder.write('the quick brown fox jumped over the lazy dog')

// or by streaming it in from a file...
fs.createReadStream('/tmp/corpus.txt').pipe(builder)

// since MarkovBuilder is a Transform stream, you can consume the output by reading from it...
builder.on('data', (ngram) => {
  // see below for structure of the `ngram`
})

// you can also pipe the Transform stream to a consumer that accepts object-mode streams
builder.pipe(storage)

Ngram structure

export type MarkovNgram = {
  // list of the words in this ngram
  ngram: string[],
  // is this a sentence starter?
  sentenceStart: boolean,
  // is this a sentence ender?
  sentenceEnd: boolean,
  // is ngram[0] proper?
  startsWithProper: boolean
}