diff options
| author | Pierre Ossman <ossman@cendio.se> | 2022-12-27 14:55:06 +0100 |
|---|---|---|
| committer | Pierre Ossman <ossman@cendio.se> | 2022-12-27 14:55:06 +0100 |
| commit | caf0ecc99b526e558ec4bd0e6d904f9acc030ccd (patch) | |
| tree | 960c39de7dfd2ba354105239cba407d8824816fc | |
| parent | ceadcd6e83c1e68de00f609153119e4fb2957be7 (diff) | |
| download | novnc-caf0ecc99b526e558ec4bd0e6d904f9acc030ccd.tar.gz | |
Consistent naming of RFB arguments
Make sure we call the arguments the same everywhere. Follow-up to commit
44d384b.
| -rw-r--r-- | docs/API.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/API.md b/docs/API.md index 443483d..d55f8d8 100644 --- a/docs/API.md +++ b/docs/API.md @@ -184,7 +184,7 @@ connection to a specified VNC server. ##### Syntax - let rfb = new RFB( target, url [, options] ); + let rfb = new RFB( target, urlOrChannel [, options] ); ###### Parameters @@ -196,7 +196,7 @@ connection to a specified VNC server. [mdn-elem]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement -**`urlOrDataChannel`** +**`urlOrChannel`** - A `DOMString` specifying the VNC server to connect to. This must be a valid WebSocket URL. This can also be a `WebSocket` or `RTCDataChannel`. |