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

markov-chains-text

v1.0.0

Published

Fake text, powered by Markov chains

Downloads

73

Readme

markov-chains-text

Fake text, powered by Markov chains

npm version


markov-chains-text is a simple, Markov chain-based text generator written in JavaScript, and designed for both Node and the browser. It can be used to generate random sentences modeled after a large corpus of text.

Table of Contents


Example

import { readFileSync } from 'fs';
import path from 'path';
import Text from 'markov-chains-text';

const MobyDick = readFileSync(path.join(__dirname, 'moby-dick.txt'));

// build the generator
const fakeMobyDick = new Text(MobyDick);

// generate a sentence
const sentence = fakeMobyDick.makeSentence();

console.log(sentence);

// Example output:
//
//   And as the Porpoise is the harpooneer might be his immediate purpose,
//   touching his own kith and kin to noble Benjamin--this day darting the
//   barbed iron from one to the captain dared not attempt, he snatched the
//   rope attached to it--for they were humbug.
//

Back to Top ↑


Installation & Usage

Requirements

markov-chains-text relies on Maps and Generators, which are available natively in Node v4.0 and above, and in modern versions of many browsers.

For a list of JavaScript environments that support these features, see the ECMAScript Compatability Table.

Downloading

npm install --save markov-chains-text

Usage (ES6+)

import Text from 'markov-chains-text';
const fakeText = new Text(/* corpus: string */);

Usage (CommonJS)

var Text = require('markov-chains-text').default;
var fakeText = new Text(/* corpus: string */);

Back to Top ↑


API Reference

Coming Soon

Back to Top ↑


Contributing

Pull requests are always welcome!

Building

The following npm scripts are available for use during development:

Command | Use to... ---------------------------|----------- npm run clean | Remove the dist/ files npm run lint | Lint the files in src/ npm run build | Transpile the code with babel

Tests

markov-chains-text uses tape for testing.

To run the tests, just run npm test at the command line.

Back to Top ↑


See Also

Back to Top ↑


License

markov-chains-text is licensed under the MIT License.

For details, please see the LICENSE file.

Back to Top ↑