Source: api-request-manager.ts

/**
 * @fileoverview A library for making requests to the Box API.
 */
// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------
import { Promise } from 'bluebird';
import { EventEmitter } from 'events';
import errors from './util/errors';
import { PassThrough } from 'stream';
const APIRequest = require('./api-request');
// -----------------------------------------------------------------------------
// Typedefs
// -----------------------------------------------------------------------------
type Config = any /* FIXME */;
// ------------------------------------------------------------------------------
// Private
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Public
// ------------------------------------------------------------------------------
/**
 * A library for communicating with the Box API.
 *
 * @param {Config} config SDK configuration object instance.
 * @param {EventEmitter} eventBus The event bus for SDK events
 * @constructor
 */
class APIRequestManager {
	config: Config;
	eventBus: EventEmitter;
	constructor(config: Config, eventBus: EventEmitter) {
		this.config = config;
		this.eventBus = eventBus;
	}
	/**
	 * Make a request to the API, and get the response via callback.
	 *
	 * @param {Object} options The request options
	 * @returns {Promise<Response>} A promise resolving to the response object
	 */
	makeRequest(options: any /* FIXME */) {
		// Add default APIRequestManager options to each request
		var requestConfig = this.config.extend({
			request: options,
		});
		// Make the request
		var apiRequest = new APIRequest(requestConfig, this.eventBus);
		return Promise.fromCallback((callback) =>
			apiRequest.execute(callback)
		).catch((err) => errors.unwrapAndThrow(err));
	}
	/**
	 * Make a request to the API, and return a read stream for the response.
	 *
	 * @param {Object} options The request options
	 * @returns {Stream.Readable} The response stream
	 */
	makeStreamingRequest(options: any /* FIXME */) {
		// Add default APIRequestManager options to each request
		var requestConfig = this.config.extend({
			request: options,
		});
		// Make the request
		var apiRequest = new APIRequest(requestConfig, this.eventBus);
		apiRequest.execute();
		var stream = apiRequest.getResponseStream();
		// The request is asynchronous, so we need to wait for the stream to be
		// available before we can pipe it to the pass-through stream.
		// If the stream is undefined, then the request failed and we should
		// propagate the error.
		if (
			stream &&
			requestConfig.disableStreamPassThrough !== true &&
			options.disableStreamPassThrough !== true
		) {
			var passThrough = new PassThrough();
			stream.pipe(passThrough);
			return passThrough;
		}
		return stream;
	}
}
/**
 * @module box-node-sdk/lib/api-request-manager
 * @see {@Link APIRequestManager}
 */
export = APIRequestManager;