Skip to content

Commit

Permalink
[doc] Fix createWebSocketStream() documentation
Browse files Browse the repository at this point in the history
The ES module wrapper exports `createWebSocketStream()` as a named
export and not as a static method of the `WebSocket` class.
  • Loading branch information
lpinca committed Aug 15, 2021
1 parent f38247e commit c677aab
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/ws.md
Expand Up @@ -43,7 +43,7 @@
- [websocket.send(data[, options][, callback])](#websocketsenddata-options-callback)
- [websocket.terminate()](#websocketterminate)
- [websocket.url](#websocketurl)
- [WebSocket.createWebSocketStream(websocket[, options])](#websocketcreatewebsocketstreamwebsocket-options)
- [createWebSocketStream(websocket[, options])](#createwebsocketstreamwebsocket-options)
- [WS Error Codes](#ws-error-codes)
- [WS_ERR_EXPECTED_FIN](#ws_err_expected_fin)
- [WS_ERR_EXPECTED_MASK](#ws_err_expected_mask)
Expand Down Expand Up @@ -514,7 +514,7 @@ Forcibly close the connection. Internally this calls [socket.destroy()][].

The URL of the WebSocket server. Server clients don't have this attribute.

## WebSocket.createWebSocketStream(websocket[, options])
## createWebSocketStream(websocket[, options])

- `websocket` {WebSocket} A `WebSocket` object.
- `options` {Object} [Options][duplex-options] to pass to the `Duplex`
Expand Down

0 comments on commit c677aab

Please sign in to comment.