UNPKG

473 BTypeScriptView Raw
1export declare type WordCount = 12 | 15 | 18 | 21 | 24;
2/**
3 * @name mnemonicGenerate
4 * @summary Creates a valid mnemonic string using using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
5 * @example
6 * <BR>
7 *
8 * ```javascript
9 * import { mnemonicGenerate } from '@polkadot/util-crypto';
10 *
11 * const mnemonic = mnemonicGenerate(); // => string
12 * ```
13 */
14export declare function mnemonicGenerate(numWords?: WordCount, onlyJs?: boolean): string;