[doc] Add JSDoc for the finishRequest option

websockets · Dec 9, 2023 · 603a039 · 603a039
1 parent c320738
commit 603a039
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/websocket.js b/lib/websocket.js
@@ -618,6 +618,8 @@ module.exports = WebSocket;
  * @param {(String|URL)} address The URL to which to connect
  * @param {Array} protocols The subprotocols
  * @param {Object} [options] Connection options
+ * @param {Function} [options.finishRequest] A function which can be used to
+ *     customize the headers of each http request before it is sent
  * @param {Boolean} [options.followRedirects=false] Whether or not to follow
  *     redirects
  * @param {Function} [options.generateMask] The function used to generate the