jcarr
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Consistent naming of RFB arguments 

Make sure we call the arguments the same everywhere. Follow-up to commit
44d384b.
This commit is contained in:
Pierre Ossman 2022-12-27 14:55:06 +01:00
parent ceadcd6e83
commit caf0ecc99b
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/API.md
View File

@ -184,7 +184,7 @@ connection to a specified VNC server.
##### Syntax ##### Syntax
let rfb = new RFB( target, url [, options] ); let rfb = new RFB( target, urlOrChannel [, options] );
###### Parameters ###### Parameters
@ -196,7 +196,7 @@ connection to a specified VNC server.
[mdn-elem]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement [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 `DOMString` specifying the VNC server to connect to. This must be
a valid WebSocket URL. This can also be a `WebSocket` or `RTCDataChannel`. a valid WebSocket URL. This can also be a `WebSocket` or `RTCDataChannel`.