Rhymepass

Rhymepass is a simple Javascript library to build random literary passphrases, including rhyming ones. For example, you can generate passphrases like HelpfulLayerFilmedPlayer.

Usage

import { getPassphrase, PartOfSpeech, ComplexType } from "rhymepass";

const { passphrase, entropy } = getPassphrase(
    [
        PartOfSpeech.ADJECTIVE,
        PartOfSpeech.NOUN,
        ComplexType.PAST_TENSE_VERB,
        PartOfSpeech.NOUN,
    ],
    [1, 2, 3, 2], // Rhyme Pattern
    25 // Minimum bits of entropy
);

console.log(passphrase, entropy);
// Output: HelpfulLayerFilmedPlayer 29.809370522853857

getPassphrase returns a random passphrase matching the provided requirements. If there is no passphrase matching those requirements with the minimum entropy (default 20 bits), then it returns null.

Note: rhymepass gets its entropy from WebCrypto's getRandomValues, which requires a secure context (e.g. https or Node), and will fail otherwise.

Documentation

enum PartOfSpeech {
    NOUN = 0,
    VERB,
    ADJECTIVE,
    PREPOSITION,
    ADVERB,
    CONJUNCTION,
    PRONOUN,
    EXCLAMATION,
}

enum ComplexType {
    PAST_TENSE_VERB = "PAST_TENSE_VERB",
}

function getPassphrase(
    parts: (PartOfSpeech | ComplexType)[], // Parts of speech for the passphrase, in order
    rhymePattern?: number[],               // Rhyme pattern, e.g. [1,2,1,2]
    minimumEntropy?: number                // Default 20 bits
): { passphrase: string, entropy: number} | null;