mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-04 21:15:47 +00:00
5fed1f08e4
The following methods are available directly under the RippleAPI object, not under schemaValidator: isValidAddress, isValidSecret, deriveKeypair, deriveAddress
36 lines
1.6 KiB
Plaintext
36 lines
1.6 KiB
Plaintext
## schemaValidator
|
|
|
|
Unlike the rest of the ripple-lib API, schemaValidator is a static object on RippleAPI. It provides utility methods that do not use a server.
|
|
|
|
## schemaValidate
|
|
|
|
`RippleAPI.schemaValidator.schemaValidate(schemaName: string, object: any): void`
|
|
|
|
This method checks an object for conformance to a specified schema. It does not return anything, but will throw a `ValidationError` if the object does not conform to the schema.
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
RippleAPI.schemaValidator.schemaValidate('sign', {
|
|
signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100BDE09A1F6670403F341C21A77CF35BA47E45CDE974096E1AA5FC39811D8269E702203D60291B9A27F1DCABA9CF5DED307B4F23223E0B6F156991DB601DFB9C41CE1C770A726970706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304',
|
|
id: '02ACE87F1996E3A23690A5BB7F1774BF71CCBA68F79805831B42ABAD5913D6F4'
|
|
})
|
|
```
|
|
|
|
```json
|
|
undefined
|
|
```
|
|
|
|
If the object is valid (conforms to the schema), nothing is returned. Otherwise, `schemaValidate` throws an error:
|
|
|
|
```javascript
|
|
RippleAPI.schemaValidator.schemaValidate('sign', {
|
|
signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100BDE09A1F6670403F341C21A77CF35BA47E45CDE974096E1AA5FC39811D8269E702203D60291B9A27F1DCABA9CF5DED307B4F23223E0B6F156991DB601DFB9C41CE1C770A726970706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304',
|
|
id: '123'
|
|
})
|
|
```
|
|
|
|
```
|
|
[ValidationError(instance.id does not match pattern "^[A-F0-9]{64}$")]
|
|
```
|