Add stream example notes

Author: Veronika Matyus

test/examples/src/js/UpdateDoc.js

@@ -36,6 +36,14 @@ const updateDoc = async () => {
       })
     ).result;
 
+    // Note: for byte response (Output Stream) use:
+    // const documentAsStream = (
+    //     await client.getDocumentAsStream({
+    //       docId: 'example',
+    //       db: exampleDbName,
+    //     })
+    // ).result;
+
     // Add Bob Smith's address to the document
     document.address = '19 Front Street, Darlington, DL5 1TY';
 
@@ -50,6 +58,14 @@ const updateDoc = async () => {
       })
     ).result.rev;
 
+    // Note: for byte request (Input Stream) use:
+    // document._rev = (
+    //     await client.postDocument({
+    //       db: exampleDbName,
+    //       document: inputStream,
+    //     })
+    // ).result.rev;
+
     console.log(
       'You have updated the document:\n' + JSON.stringify(document, null, 2)
     );

test/examples/src/ts/UpdateDoc.ts

@@ -35,6 +35,15 @@ const getDocParams: CloudantV1.GetDocumentParams = {
   db: exampleDbName,
 };
 
+// Note: for byte response (Output Stream) use:
+// const getdocAsStreamParam: CloudantV1.GetDocumentAsStreamParams = {
+//   docId: 'example',
+//   db: exampleDbName,
+// };
+// client
+//   .getDocumentAsStream(getdocAsStreamParam)
+//   .then((outputStream) => {});
+
 client
   .getDocument(getDocParams)
   .then((docResult) => {
@@ -48,13 +57,19 @@ client
     delete document.joined;
 
     // Update the document in the database
-    client.postDocument({ db: exampleDbName, document }).then((res) => {
-      // Keeping track with the revision number of the document object:
-      document._rev = res.result.rev;
-      console.log(
-        'You have updated the document:\n' + JSON.stringify(document, null, 2)
-      );
-    });
+    client
+      .postDocument({ db: exampleDbName, document })
+      // Note: for byte request (Input Stream) use:
+      // .postDocument(
+      //   {db: exampleDbName, documentAsStream}
+      // )
+      .then((res) => {
+        // Keeping track with the revision number of the document object:
+        document._rev = res.result.rev;
+        console.log(
+          'You have updated the document:\n' + JSON.stringify(document, null, 2)
+        );
+      });
   })
   .catch((err) => {
     if (err.code === 404) {