metaapi.cloud-sdk
Version:
SDK for MetaApi, a professional cloud forex API which includes MetaTrader REST API and MetaTrader websocket API. Supports both MetaTrader 5 (MT5) and MetaTrader 4 (MT4). CopyFactory copy trading API included. (https://metaapi.cloud)
33 lines (32 loc) • 1.21 kB
TypeScript
/**
* Class for validating API options.
*/
export default class OptionsValidator {
/**
* Validates a number parameter
* @param {Number} value value to validate
* @param {Number} defaultValue default value for an option
* @param {String} name option name
* @returns {Number} validated value
* @throws {ValidationError} if value is invalid
*/
validateNumber(value: any, defaultValue: any, name: any): any;
/**
* Validates a number parameter to be above zero
* @param {Number} value value to validate
* @param {Number} defaultValue default value for an option
* @param {String} name option name
* @returns {Number} validated value
* @throws {ValidationError} if value is invalid
*/
validateNonZero(value: any, defaultValue: any, name: any): any;
/**
* Validates a parameter to be boolean
* @param {Boolean} value value to validate
* @param {Boolean} defaultValue default value for an option
* @param {String} name option name
* @returns {Boolean} validated value
* @throws {ValidationError} if value is invalid
*/
validateBoolean(value: any, defaultValue: any, name: any): any;
}