Add default configuration and documents

docs/configuration.md

@@ -53,6 +53,17 @@ sdk.configure({
 });
 ```
 
+## Disable stream PassThrough for streaming responses
+
+By default the SDK uses `PassThrough` stream to handle streaming responses. It helps to support delayed reading of the response body, but in some cases it can cause memory leaks or not fully works. To disable `PassThrough` stream use the `disableStreamPassThrough` method:
+
+```javascript
+sdk = BoxSDKNode.getPreconfiguredInstance(APP_SETTINGS);
+sdk.configure({
+ disableStreamPassThrough: true
+});
+```
+
 ## Configure Base URL
 
 The Base Url is the URL that is used by the SDK to access Box. The default base URL are already defined

src/api-request-manager.ts

@@ -83,7 +83,11 @@ class APIRequestManager {
  // 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 && options.disableStreamPassthrough !== true) {
+ if (
+ stream &&
+ requestConfig.disableStreamPassThrough !== true &&
+ !options.disableStreamPassThrough
+ ) {
  var passThrough = new PassThrough();
  stream.pipe(passThrough);
  return passThrough;

src/util/config.ts

@@ -94,6 +94,7 @@ var defaults = {
  iterators: false,
  enterpriseID: undefined,
  analyticsClient: null,
+ disableStreamPassThrough: false,
  proxy: {
  url: null,
  username: null,

tests/lib/api-request-manager-test.js

@@ -232,7 +232,7 @@ describe('APIRequestManager', function() {
  assert.equal(typeof response, typeof expectedResponse);
  });
 
- it('should return the Stream directly when `disableStreamPassthrough` is true', function() {
+ it('should return the Stream directly when `disableStreamPassThrough` is true', function() {
  var requestManager = new APIRequestManager(config, eventBusFake),
  expectedResponse = new Stream(),
  response;
@@ -241,7 +241,7 @@ describe('APIRequestManager', function() {
  sandbox.mock(apiRequestFake).expects('getResponseStream')
  .withExactArgs()
  .returns(expectedResponse);
- response = requestManager.makeStreamingRequest({ disableStreamPassthrough: true });
+ response = requestManager.makeStreamingRequest({ disableStreamPassThrough: true });
  assert.notInstanceOf(response, Stream.PassThrough);
  assert.equal(typeof response, typeof expectedResponse);
  });