UNPKG

@polkadot/util-crypto/mnemonic/generate.d.ts

Version:

451 BTypeScriptView Raw

1/**
* @name mnemonicGenerate
* @summary Creates a valid mnemonic string using using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
* @example
* <BR>
*
* ```javascript
* import { mnemonicGenerate } from '@polkadot/util-crypto';
*
* const mnemonic = mnemonicGenerate(); // => string
* ```
*/
13export declare function mnemonicGenerate(numWords?: 12 | 15 | 18 | 21 | 24, wordlist?: string[], onlyJs?: boolean): string;

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