Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abranhe/all-words
All Words: Generate all available words (up to four letters) super fast
https://github.com/abranhe/all-words
all-words words
Last synced: 8 days ago
JSON representation
All Words: Generate all available words (up to four letters) super fast
- Host: GitHub
- URL: https://github.com/abranhe/all-words
- Owner: abranhe
- License: mit
- Created: 2018-07-29T17:49:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-17T16:05:41.000Z (almost 3 years ago)
- Last Synced: 2024-10-12T12:14:56.777Z (about 1 month ago)
- Topics: all-words, words
- Language: JavaScript
- Homepage: https://npm.im/all-words
- Size: 25.5 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
All Words: Generate all available words (up to four letters) super fast
# Why?
- Why not?, lol 😂
- Clean and focused
- Actively maintained
- [CLI included](#cli)
- Fast and straightforward
# Install
```
$ npm install all-words
```
>  Wow
>
> This will generate over +450 000 words in just a second
# Usage
```js
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
**.alphabet**
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](https://github.com/abranhe/r4nd0mstr1ng): random string generator
# Team
|[](https://19cah.com)|
| :-: |
| [Carlos Abraham](https://github.com/abranhe) |
# License
[MIT](https://github.com/abranhe/all-words/blob/master/LICENSE) License © [Carlos Abraham](https://github.com/abranhe/)