Giter Club home page Giter Club logo

smallwords's Introduction

Small Words

Super small script gives words (chars = fives). Store trees - keeps sizes lower. Check valid. Great speed.

Details

This package stores a (parsed) dictionary tree of 5 letter words and will return one, or several random words, as either a string, or an array of strings respectively.

All words are stored, and returned in upper case.

Functions available for use:

generateWord

import { generateWord } from 'smallwords';

const word = generateWord(); // 'ABATE'

generateNWords

import { generateNWords } from 'smallwords';

const words = generateNWords(5); // ['EQUAL', 'GHOST', 'CYCLE', 'HOTEL', 'REIGN']

checkWordExists

import { checkWordExists } from 'smallwords';

const exists = checkWordExists('KNOWN'); // true

Note

The published package only includes a subset of 5-letter words, however the repository contains a word list of many thousands of words that have not yet been parsed. Many of the words are literally valid, but are hyper obscure and would end a casual friendship over a game of Scrabble.

The wordlists I have used here have removed proper nouns, brand names, acronyms, etc. but additionally for my purposes I wanted to make sure that the words were appropriate, and so I have manually checked each word (which, as you'd expect, takes time).

If you would like to use the full list for other purposes, please feel free to grab it on Github and do so.

Contribute

If you would like to see more words in the approved list, please submit a PR having parsed them yourself and we can add them in.

For questions, feedback or suggestions, please open an issue in the GitHub repo;

Thanks

Words compiled from multiple sources and parsed to leave only those with 5 letters. Mostly the RIDYHEW dictionary.

smallwords's People

Contributors

eddhurst avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.