Files
common/docs/util-crypto/modules/_mnemonic_validate_.md
T
2019-02-15 07:40:22 +00:00

36 lines
759 B
Markdown

# Functions
<a id="mnemonicvalidate"></a>
## mnemonicValidate
▸ **mnemonicValidate**(mnemonic: *`string`*): `boolean`
*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/49b0c84/packages/util-crypto/src/mnemonic/validate.ts#L20)*
*__name__*: mnemonicValidate
*__summary__*: Validates a mnemonic input using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
*__example__*:
```javascript
import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
const mnemonic = mnemonicGenerate(); // => string
const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
```
**Parameters:**
| Name | Type |
| ------ | ------ |
| mnemonic | `string` |
**Returns:** `boolean`
___