API reference / @evolu/common / Type / Mnemonic

Variable: Mnemonic

const Mnemonic: BrandType<
  BrandType<
    Type<
      "Brand",
      string & Brand<"Trimmed">,
      string,
      TrimmedError,
      string,
      StringError
    >,
    "MinLength1",
    MinLengthError<1>,
    StringError | TrimmedError
  >,
  "Mnemonic",
  MnemonicError,
  StringError | TrimmedError | MinLengthError<1>
>;

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

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.