Document default option values for createServer()

okTurtles · Apr 7, 2021 · e01cd71 · e01cd71
1 parent e4a2188
commit e01cd71
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/backend/pubsub.js b/backend/pubsub.js
@@ -53,11 +53,12 @@ export function createResponse (type: ResponseTypeEnum, data: JSONType): string
  * {object?} messageHandlers - Custom handlers for different message types.
  * {object?} serverHandlers - Custom handlers for server events.
  * {object?} socketHandlers - Custom handlers for socket events.
- * {number} backlog - The maximum length of the queue of pending connections.
- * {Function} handleProtocols - A function which can be used to handle the WebSocket subprotocols.
- * {number} maxPayload - The maximum allowed message size in bytes.
- * {string} path - Accept only connections matching this path.
- * {(boolean|object)} perMessageDeflate - Enables/disables per-message deflate.
+ * {number?} backlog=511 - The maximum length of the queue of pending connections.
+ * {Function?} handleProtocols - A function which can be used to handle the WebSocket subprotocols.
+ * {number?} maxPayload=6_291_456 - The maximum allowed message size in bytes.
+ * {string?} path - Accept only connections matching this path.
+ * {(boolean|object)?} perMessageDeflate - Enables/disables per-message deflate.
+ * {number?} pingInterval=30_000 - The time to wait between successive pings.
  * @returns {Object}
  */
 export function createServer (httpServer: Object, options?: Object = {}): Object {