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

foswig

v3.0.1

Published

A library that can generate legible pseudo random words based off an input dictionary using markov chains

Downloads

237

Readme

Foswig.js

Build Status npm version

A JavaScript library which allows you to easily create Markov chains based on arbitrary dictionaries in order to create readable pseudo-random words (Yes, the name was generated by the library). See a demo of this library in action here.

Usage

// If you're using the following
// - A bundler like Rollup or Webpack
// - node>=12 and have set "type": "module" in your package.json
// - node>=12 and the parent file has a .mjs extension
import Foswig from 'foswig';
// otherwise require using commonjs
const Foswig = require('foswig').default;

// Create the Markov chain and specify the order of the chain & input dictionary
// The order (an integer that is greater than 0) indicates how many previous 
// letters are taken into account when selecting the next one. A smaller order 
// will result in a more randomized, less recognizeable output. Also, a higher 
// order will result in words which resemble more closely to those in the original 
//dictionary.
const chain = new Foswig(3, [
  "hello",
  "foswig",
]);


// Generate a random word with a minimum of 5 characters, a maximum of 10 letters, 
// and that cannot be a match to any of the input dictionaries words.
const constraints = { 
  minLength: 2, 
  maxLength: 10, 
  allowDuplicates: true
};
const word = chain.generate(constraints);

Constraints

  • minLength (optional, default: 0): Minimum length of the word (optional, default: 0)
  • maxLength (optional, default: 0): Maximum length of the word, 0 indicates no max length)
  • allowDuplicates (optional, default: true): Can the output be an exact match of a dictionary input word or not
  • maxAttempts (optional, default: 25): The maximum number of attempts to generate a word matching the constraints above before throwing an error, use 0 to allow infinite attempts, but this may result in hangs if the constraints cannot be satisfied.
  • random (optional, default: Math.random): A function that returns a random floating point number between 0-1.

License

Foswig.js is licensed under the MIT license.