UNPKG

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

Version:

511 BTypeScriptView Raw

1/**
* @name mnemonicValidate
* @summary Validates a mnemonic input using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
* @example
* <BR>
*
* ```javascript
* import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
*
* const mnemonic = mnemonicGenerate(); // => string
* const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
* ```
*/
14export declare function mnemonicValidate(mnemonic: string, wordlist?: string[], onlyJs?: boolean): boolean;

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