Skip to content

Commit

Permalink
[doc] Fix data argument type (#1843)
Browse files Browse the repository at this point in the history
  • Loading branch information
rschristian authored Feb 7, 2021
1 parent 223194e commit 99338f7
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/ws.md
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,8 @@ receives an `OpenEvent` named "open".

### websocket.ping([data[, mask]][, callback])

- `data` {Any} The data to send in the ping frame.
- `data` {Array|Number|Object|String|ArrayBuffer|Buffer|DataView|TypedArray} The
data to send in the ping frame.
- `mask` {Boolean} Specifies whether `data` should be masked or not. Defaults to
`true` when `websocket` is not a server client.
- `callback` {Function} An optional callback which is invoked when the ping
Expand All @@ -427,7 +428,8 @@ Send a ping.

### websocket.pong([data[, mask]][, callback])

- `data` {Any} The data to send in the pong frame.
- `data` {Array|Number|Object|String|ArrayBuffer|Buffer|DataView|TypedArray} The
data to send in the pong frame.
- `mask` {Boolean} Specifies whether `data` should be masked or not. Defaults to
`true` when `websocket` is not a server client.
- `callback` {Function} An optional callback which is invoked when the pong
Expand Down Expand Up @@ -456,7 +458,8 @@ Removes an event listener emulating the `EventTarget` interface.

### websocket.send(data[, options][, callback])

- `data` {Any} The data to send.
- `data` {Array|Number|Object|String|ArrayBuffer|Buffer|DataView|TypedArray} The
data to send.
- `options` {Object}
- `compress` {Boolean} Specifies whether `data` should be compressed or not.
Defaults to `true` when permessage-deflate is enabled.
Expand Down

0 comments on commit 99338f7

Please sign in to comment.