playsocketjs 2.5.1 → 2.5.2

package/README.md

@@ -143,7 +143,7 @@ Here are usage examples for a standalone server and an Express.js application.
 ```javascript
 import PlaySocketServer from 'playsocketjs/server'; // Both ES Module & CommonJS Module syntax is supported
 
-const server = new PlaySocketServer(); // Create and start the server (default path is /socket)
+const server = new PlaySocketServer(); // Create and start the server (default path is /)
 
 // Gracefully disconnect all clients and close the server (optional)
 function shutdown() {

package/dist/playsocket-client.js

@@ -2110,6 +2110,7 @@ class PlaySocket {
      * @param {object} options - Connection options
      * @param {string} options.endpoint - WebSocket endpoint path
      * @param {object} [options.customData] - Custom registration data
+     * @param {boolean} [options.debug=false] - Enable debug logging
      */
     constructor(id, options = {}) {
         this.#id = id;
@@ -2488,7 +2489,7 @@ class PlaySocket {
     /**
      * Update a value in the shared storage
      * @param {string} key - Storage key
-     * @param {string} type - Operation type: add, add-unique, remove-matching, update-matching
+     * @param {'set' | 'array-add' | 'array-add-unique' | 'array-remove-matching' | 'array-update-matching'} type - Operation type
      * @param {*} value - New value or value to operate on
      * @param {*} updateValue - New value for update-matching
      */

package/dist/playsocket-server.cjs

@@ -2110,7 +2110,9 @@ class PlaySocketServer {
      * @param {Object} options - Server configuration options
      * @param {HttpServer} [options.server] - Existing http server
      * @param {number} [options.port=3000] - Port to listen on (if no server provided)
-     * @param {string} [options.path='/socket'] - WebSocket endpoint path
+     * @param {string} [options.path='/'] - WebSocket endpoint path
+     * @param {boolean} [options.debug=false] - Enable debug logging
+     * @param {number} [options.rateLimit=20] - Maximum number of operations per second per client
      */
     constructor(options = {}) {
         const { server, port = 3000, path = '/', debug = false, rateLimit = 20 } = options;
@@ -2617,7 +2619,7 @@ class PlaySocketServer {
      * Update a value in a room's storage
      * @param {string} roomId - Room ID
      * @param {string} key - Storage key
-     * @param {string} type - Operation type
+     * @param {'set' | 'array-add' | 'array-add-unique' | 'array-remove-matching' | 'array-update-matching'} type - Operation type
      * @param {*} value - New value or value to operate on
      * @param {*} updateValue - New value for update-matching
      */

package/dist/playsocket-server.mjs

@@ -2089,7 +2089,9 @@ class PlaySocketServer {
      * @param {Object} options - Server configuration options
      * @param {HttpServer} [options.server] - Existing http server
      * @param {number} [options.port=3000] - Port to listen on (if no server provided)
-     * @param {string} [options.path='/socket'] - WebSocket endpoint path
+     * @param {string} [options.path='/'] - WebSocket endpoint path
+     * @param {boolean} [options.debug=false] - Enable debug logging
+     * @param {number} [options.rateLimit=20] - Maximum number of operations per second per client
      */
     constructor(options = {}) {
         const { server, port = 3000, path = '/', debug = false, rateLimit = 20 } = options;
@@ -2596,7 +2598,7 @@ class PlaySocketServer {
      * Update a value in a room's storage
      * @param {string} roomId - Room ID
      * @param {string} key - Storage key
-     * @param {string} type - Operation type
+     * @param {'set' | 'array-add' | 'array-add-unique' | 'array-remove-matching' | 'array-update-matching'} type - Operation type
      * @param {*} value - New value or value to operate on
      * @param {*} updateValue - New value for update-matching
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playsocketjs",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "description": "WebSocket wrapper for creating simple multiplayer systems with ease.",
   "type": "module",
   "module": "dist/playsocket-client.js",