diceware-en
v1.1.1
Published
English diceware list with useful functions.
Downloads
19
Maintainers
Readme
diceware-en
English diceware list with useful functions. Free, typed and easy to use.
General Usage Example:
import { dicewareEN } from "diceware-en"
console.log(
dicewareEN.generatePhrase(4)
)Properties from dicewareEN object:
| Property | Description | Example |
|-------------------|-------------------------------------------------------|---------------------------------------------------|
| words | Array with all 7776 words from the diceware list | dicewareEN.words |
| generatePhrase | Generates a random passphrase based on words quantity | dicewareEN.generatePhrase(8) |
| generateKey | Generates a random Diceware Key | dicewareEN.generateKey() |
| keyToIndex | Converts a Diceware Key into a word list index | dicewareEN.keyToIndex("11111") |
| getWord | Get the corresponding word based on a Diceware Key | dicewareEN.getWord("11111") |
Types:
| Name | Description | Example |
|-------------------|-------------------------------------------------------|-------------------------------------------|
| DicewareKey | String with 5 number characters from "1" to "6" | "11111", "66666", "12346"... |
Others:
| Name | Description | Example |
|-------------------|---------------------------------------------------------------------------------------------------|-----------------------|
| getRandomInt | Generates a random int number from 0 to an max inclusive value using crypto.getRandomValues() | getRandomInt(10) |
Notes
- All words have between 4 and 7 letters.
- Problematic words have been avoided.
- Extremely little-known words have been avoided.
- You can manually check all current used words here.
Tips
- Warn your user that sentences with negative interpretations may arise due to the randomness of words (even with a set of words avoiding huge offenses, the random combination of words can generate a sentence that can be interpreted in a pejorative way about something)
Do you speak English? Feel free to improve the list! 😊
You can find more information about how to do that here.
