@barchart/common-js/network/rest/RestProviderBase.js

Library of common JavaScript utilities

const assert = require('./../../lang/assert');

const RestEndpoint = require('./RestEndpoint');

module.exports = (() => {
	'use strict';

	/**
	 * Executes REST-ful actions.
	 *
	 * @public
	 * @param {String} host - The host name to call
	 * @param {Number=} port - The port
	 * @param {Boolean=} secure - If true, HTTPS is used; otherwise HTTP.
	 * @interface
	 */
	class RestProviderBase {
		constructor(host, port, secure) {
			assert.argumentIsRequired(host, 'host', String);
			assert.argumentIsRequired(port, 'port', Number);
			assert.argumentIsRequired(secure, 'secure', Boolean);

			this._host = host;
			this._port = port;
			this._secure = secure;
		}

		/**
		 * Triggers a REST action targeting a {@link RestEndpoint}.
		 *
		 * @public
		 * @param {RestEndpoint} endpoint - The enpoint to call.
		 * @param {object} data - The data to pass to the endpoint.
 		 * @returns {Promise<TResult>}
		 */
		call(endpoint, data, token) {
			return Promise.resolve()
				.then(() => {
					assert.argumentIsRequired(endpoint, endpoint, RestEndpoint, 'RestEndpoint');

					return this._call(endpoint, data, this._host, this._port, this._secure, token);
				});
		}

		/**
		 * @protected
		 * @abstract
		 * @ignore
		 */
		_call(endpoint, data, host, port, secure) {
			return true;
		}

		toString() {
			return '[RestProviderBase]';
		}
	}

	return RestProviderBase;
})();