doc: not to use object stream in managed upload (#2761)

aws · Jul 9, 2019 · d05c0ca · d05c0ca
1 parent 39a4bdd
commit d05c0ca
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/s3/managed_upload.js b/lib/s3/managed_upload.js
@@ -41,6 +41,8 @@ AWS.S3.ManagedUpload = AWS.util.inherit({
    * Creates a managed upload object with a set of configuration options.
    *
    * @note A "Body" parameter is required to be set prior to calling {send}.
+   * @note In Node.js, sending "Body" as {https://nodejs.org/dist/latest/docs/api/stream.html#stream_object_mode object-mode stream}
+   *   may result in upload hangs. Using buffer stream is preferable.
    * @option options params [map] a map of parameters to pass to the upload
    *   requests. The "Body" parameter is required to be specified either on
    *   the service or in the params option.