ws - npm Package Compare versions

Comparing version 8.1.0 to 8.2.0

index.js

@@ -10,2 +10,5 @@ 'use strict';
 
+WebSocket.WebSocket = WebSocket;
+WebSocket.WebSocketServer = WebSocket.Server;
+
 module.exports = WebSocket;

lib/permessage-deflate.js

@@ -33,10 +33,14 @@ 'use strict';
    * @param {Object} [options] Configuration options
-   * @param {Boolean} [options.serverNoContextTakeover=false] Request/accept
-   *     disabling of server context takeover
+   * @param {(Boolean|Number)} [options.clientMaxWindowBits] Advertise support
+   *     for, or request, a custom client window size
    * @param {Boolean} [options.clientNoContextTakeover=false] Advertise/
    *     acknowledge disabling of client context takeover
+   * @param {Number} [options.concurrencyLimit=10] The number of concurrent
+   *     calls to zlib
    * @param {(Boolean|Number)} [options.serverMaxWindowBits] Request/confirm the
    *     use of a custom server window size
-   * @param {(Boolean|Number)} [options.clientMaxWindowBits] Advertise support
-   *     for, or request, a custom client window size
+   * @param {Boolean} [options.serverNoContextTakeover=false] Request/accept
+   *     disabling of server context takeover
+   * @param {Number} [options.threshold=1024] Size (in bytes) below which
+   *     messages should not be compressed
    * @param {Object} [options.zlibDeflateOptions] Options to pass to zlib on
@@ -46,6 +50,2 @@ *     deflate
    *     inflate
-   * @param {Number} [options.threshold=1024] Size (in bytes) below which
-   *     messages should not be compressed
-   * @param {Number} [options.concurrencyLimit=10] The number of concurrent
-   *     calls to zlib
    * @param {Boolean} [isServer=false] Create the instance in either server or
@@ -52,0 +52,0 @@ *     client mode

lib/sender.js

@@ -43,5 +43,2 @@ /* eslint no-unused-vars: ["error", { "varsIgnorePattern": "^net|tls$" }] */
    * @param {Object} options Options object
-   * @param {Number} options.opcode The opcode
-   * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
-   *     modified
    * @param {Boolean} [options.fin=false] Specifies whether or not to set the
@@ -51,2 +48,5 @@ *     FIN bit
    *     `data`
+   * @param {Number} options.opcode The opcode
+   * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
+   *     modified
    * @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
@@ -260,6 +260,6 @@ *     RSV1 bit
    * @param {Object} options Options object
+   * @param {Boolean} [options.binary=false] Specifies whether `data` is binary
+   *     or text
    * @param {Boolean} [options.compress=false] Specifies whether or not to
    *     compress `data`
-   * @param {Boolean} [options.binary=false] Specifies whether `data` is binary
-   *     or text
    * @param {Boolean} [options.fin=false] Specifies whether the fragment is the
@@ -327,4 +327,2 @@ *     last one
    * @param {Number} options.opcode The opcode
-   * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
-   *     modified
    * @param {Boolean} [options.fin=false] Specifies whether or not to set the
@@ -334,2 +332,4 @@ *     FIN bit
    *     `data`
+   * @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
+   *     modified
    * @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
@@ -336,0 +336,0 @@ *     RSV1 bit

lib/websocket.js

@@ -381,6 +381,6 @@ 'use strict';
    * @param {Object} [options] Options object
+   * @param {Boolean} [options.binary] Specifies whether `data` is binary or
+   *     text
    * @param {Boolean} [options.compress] Specifies whether or not to compress
    *     `data`
-   * @param {Boolean} [options.binary] Specifies whether `data` is binary or
-   *     text
    * @param {Boolean} [options.fin=true] Specifies whether the fragment is the
@@ -569,16 +569,16 @@ *     last one
  * @param {Object} [options] Connection options
- * @param {(Boolean|Object)} [options.perMessageDeflate=true] Enable/disable
- *     permessage-deflate
+ * @param {Boolean} [options.followRedirects=false] Whether or not to follow
+ *     redirects
  * @param {Number} [options.handshakeTimeout] Timeout in milliseconds for the
  *     handshake request
- * @param {Number} [options.protocolVersion=13] Value of the
- *     `Sec-WebSocket-Version` header
- * @param {String} [options.origin] Value of the `Origin` or
- *     `Sec-WebSocket-Origin` header
  * @param {Number} [options.maxPayload=104857600] The maximum allowed message
  *     size
- * @param {Boolean} [options.followRedirects=false] Whether or not to follow
- *     redirects
  * @param {Number} [options.maxRedirects=10] The maximum number of redirects
  *     allowed
+ * @param {String} [options.origin] Value of the `Origin` or
+ *     `Sec-WebSocket-Origin` header
+ * @param {(Boolean|Object)} [options.perMessageDeflate=true] Enable/disable
+ *     permessage-deflate
+ * @param {Number} [options.protocolVersion=13] Value of the
+ *     `Sec-WebSocket-Version` header
  * @param {Boolean} [options.skipUTF8Validation=false] Specifies whether or
@@ -585,0 +585,0 @@ *     not to skip UTF-8 validation for text and close messages

package.json

 {
   "name": "ws",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "Simple to use, blazing fast and thoroughly tested websocket client and server for Node.js",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

126064

increased by0.06%

Lines of code

3662

increased by0.05%

No dependency changes