Collection of guards and validators, useful in IOTA development.
Collection of guards and validators, useful in IOTA development.
Instal using npm:
``
npm install @iota/validators
or using yarn:
`
yarn add @iota/validators
* _static_
* .isAddress(address)
* _inner_
* ~isTrits(input)
* [~isTrytes(trytes, [length])](#module_validators..isTrytes)
* ~isTrytesOfExactLength(trytes, length)
* ~isTrytesOfMaxLength(trytes, length)
| Param | Type | Description |
| --- | --- | --- |
| address | string | Address with a checksum |
This method takes an address with a checksum and validates that the checksum is correct.
To generate a new address with a checksum, use the getNewAddress() method.
Returns: boolean - valid - Whether the checksum is valid
Example
`js`
let valid = Validator.isAddress('9FNJWLMBECSQDKHQAGDHDPXBMZFMQIMAFAUIQTDECJVGKJBKHLEBVU9TWCTPRJGYORFDSYENIQKBVSYKW9NSLGS9UW');
| Param | Type |
| --- | --- |
| input | any |
Checks if input is an Int8Array of trit values; -1, 0, 1.
| Param | Type |
| --- | --- |
| trits | Int8Array |
Checks if trits are NULL.
| Param | Type | Default |
| --- | --- | --- |
| trytes | string | |
| [length] | string \| number | "'1,'" |
Checks if input is correct trytes consisting of [9A-Z]; optionally validate length
| Param | Type |
| --- | --- |
| trytes | string |
| length | number |
| Param | Type |
| --- | --- |
| trytes | string |
| length | number |
| Param | Type |
| --- | --- |
| hash | string |
Checks if input contains 9s only.
| Param | Type |
| --- | --- |
| hash | string |
Checks if input is correct hash (81 trytes) or address with checksum (90 trytes)
| Param | Type |
| --- | --- |
| address | string |
Checks if input is valid input object. Address can be passed with or without checksum.
It does not validate the checksum.
| Param | Type |
| --- | --- |
| tag | string |
Checks that input is valid tag trytes.
| Param | Type |
| --- | --- |
| transfer | Transfer |
Checks if input is valid transfer object.
| Param | Type |
| --- | --- |
| uri | string |
Checks that a given URI is valid
Valid Examples:
- udp://[2001:db8:a0b:12f0::1]:14265
-
-
-
-
- Error error
Runs each validator in sequence, and throws on the first occurence of invalid data.
Validators are passed as arguments and executed in given order.
You might want place validate() in promise chains before operations that require valid inputs,
taking advantage of built-in promise branching.
Example
`js``
try {
validate([
value, // Given value
isTrytes, // Validator function
'Invalid trytes' // Error message
])
} catch (err) {
console.log(err.message) // 'Invalid trytes'
}