Skip to content

matthewhudson/words

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

55 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

The TypeScript module words generates a list of words from a word, or a few letters. It's helpful for providing hints while playing games like Letterpress, Words with Friends, and Scrabble.

codecov

Web Application Demo

Requirements

  • Node.js 22+
  • pnpm

Installation

pnpm add words

Usage

import { WordGenerator } from "words";

const wg = new WordGenerator();
await wg.generateTree();
const anagrams = wg.getAnagrams(["h", "e", "l", "l", "o"]);
console.log(anagrams);

A demo version is available online:

curl https://httpip.es/api/words?letters=h,e,l,l,o

Development

pnpm install        # Install dependencies
pnpm type-check     # Run TypeScript type checking
pnpm build          # Compile TypeScript to dist/
pnpm test           # Run tests
pnpm dev            # Watch mode for TypeScript compilation

Suggestions

All comments in how to improve this library are very welcome. Feel free post suggestions to the Issue tracker, or even better, fork the repository to implement your own ideas and submit a pull request.

License

Unless attributed otherwise, everything is under the MIT License (see LICENSE for more info).

About

πŸ††πŸ…ΎπŸ†πŸ…³πŸ†‚ JS module for generating words from characters. An anagram generator. Helpful (for cheating) when playing games like Letterpress, Words with Friends, and Scrabble.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors