stream: change comment on duplex stream options

'options.XXX' did not convey to me how to use camelCase for different readable and writable options on a duplex stream. Give an example instead. PR-URL: #24247 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Nov 28, 2018 · 01e8a3a · 01e8a3a
1 parent 415340f
commit 01e8a3a
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/_stream_writable.js b/lib/_stream_writable.js
@@ -57,8 +57,8 @@ function WritableState(options, stream, isDuplex) {
   // Duplex streams are both readable and writable, but share
   // the same options object.
   // However, some cases require setting options to different
-  // values for the readable and the writable sides of the duplex stream.
-  // These options can be provided separately as readableXXX and writableXXX.
+  // values for the readable and the writable sides of the duplex stream,
+  // e.g. options.readableObjectMode vs. options.writableObjectMode, etc.
   if (typeof isDuplex !== 'boolean')
     isDuplex = stream instanceof Stream.Duplex;