route4me-node
Version:
Access Route4Me's logistics-as-a-service API using our Node.js SDK
62 lines (54 loc) • 1.5 kB
JavaScript
/**
* @module route4me-node
*/
var errors = require("./errors");
var Route4Me = require("./route4me");
module.exports = function route4meModule() {
for (var _len = arguments.length, args = Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
return new (Function.prototype.bind.apply(Route4Me, [null].concat(args)))();
};
module.exports.version = Route4Me.version;
/**
* API-response callback
*
* @callback RequestCallback
* @category Route4Me
* @param {Error} err - Error (if ocurred)
* @param {Object} [res=undefined] - Value returned by API (on success)
*/
/**
* Validation callback, applied to each API-response
*
* @callback ValidationCallback
*
* @private
*
* @param {*} obj - Object to validate. Route4Me will pass
* API-responses with this argument
*
* @param {string} schemaName - Name of the schema to validate against.
* Route4Me will pass the name of appropriate schema for validation.
*
* @return {*|Error} Returns:
* * {@link Error} on validation error
* * `obj` argument (modifications allowed)
*/
/**
* @type {Route4Me}
*/
module.exports.Route4Me = Route4Me;
/**
* @type {Route4MeError}
*/
module.exports.Route4MeError = errors.Route4MeError;
/**
* @type {Route4MeApiError}
*/
module.exports.Route4MeApiError = errors.Route4MeApiError;
/**
* @type {Route4MeValidationError}
*/
module.exports.Route4MeValidationError = errors.Route4MeValidationError;
;