API reference › @evolu/common › Type › Mnemonic

const Mnemonic: brand(
  "Mnemonic",
  NonEmptyTrimmedString,
  (value) =>
    bip39.validateMnemonic(value, wordlist)
      ? ok(value)
      : err<MnemonicError>({ type: "Mnemonic", value }),
);

Defined in: packages/common/src/Type.ts:1469

The mnemonic, also known as a "seed phrase," is a set of 12 words in a specific order chosen from a predefined list (BIP39). It provides a human-readable way to store a private key securely. The mnemonic is generated safely on the user's device using cryptographically secure random number generation, ensuring it remains private and unique.