all-words

1.0.1 • Public • Published




All Words: Generate all available words (up to four letters) super fast

Why?

  • Why not?, lol 😂
  • Clean and focused
  • Actively maintained
  • CLI included
  • Fast and straightforward

Install

$ npm install all-words

wow Wow

This will generate over +450 000 words in just a second

Usage

const allWords = require('all-words');
 
console.log(allWords.rand(), allWords.rand(), allWords.rand());
//=> 'as lsfk wls'
 
allWords.letter();
//=> 'z'
 
allWords.twoLetters();
//=> 'xc'
 
allWords.fourLetters();
//=> 'ughp'
 
console.log(allWords.alphabet);
//=> ['a', 'b' .... 'z']
 
console.log(allWords.allThree);
//=> ['aaa', 'aab' .... 'zzz']

API

rand()

Type: function

Return a random word with a random size from 1 - 4

letter()

Type: function

Return a random vowel

twoLetters()

Type: function

Return a random word with two letters

threeLetters()

Type: function

Return a random word with three letters

fourLetters()

Type: function

Return a random word with four letters

.alpabet

Type: array

Return an array with all vowels of the alphabet

.allTwo

Type: array

Return an array with all words with two letters

.allThree

Type: array

Return an array with all words with three letters

.allFour

Type: array

Return an array with all words with four letters

CLI

$ all-words --help

Examples
    $ all-words
    blj

    $ all-words --all-two
    aa
    ab
    ac
    ...

    $ all-words --rand-three
    ghr

    Options
        --help             show this help and close
        --letter           generate a random letter from the alphabet
        --two-letters      generate a random word with two letters
        --three-letters    generate a random word with three letters
        --four-letters     generate a random word with four letters
        --alphabet         return array with all letters from the alphabet
        --all-two          return array with all words with two letters
        --all-three        return array with all words with three letters
        --all-four         return array with all words with four letters

Related

r4nd0mstr1ng:  random string generator

Team

Carlos Abraham Logo
Carlos Abraham

License

MIT License © Carlos Abraham

Package Sidebar

Install

npm i all-words

Weekly Downloads

5

Version

1.0.1

License

MIT

Unpacked Size

3.32 MB

Total Files

12

Last publish

Collaborators

  • abranhe