Skip to content

Commit

Permalink
Document that ports to cycle can be configured
Browse files Browse the repository at this point in the history
  • Loading branch information
Berenz committed Apr 27, 2017
1 parent 732f54c commit f67b79c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions js/qz-tray.js
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,9 @@ var qz = (function() {
*
* @param {Object} [options] Configuration options for the web socket connection.
* @param {string|Array<string>} [options.host=['localhost', 'localhost.qz.io']] Host running the QZ Tray software.
* @param {Object} [options.port] Config options for ports to cycle.
* @param {Array<number>} [options.port.secure=[8181, 8282, 8383, 8484]] Array of secure (WSS) ports to try
* @param {Array<number>} [options.port.insecure=[8182, 8283, 8384, 8485]] Array of insecure (WS) ports to try
* @param {boolean} [options.usingSecure=true] If the web socket should try to use secure ports for connecting.
* @param {number} [options.keepAlive=60] Seconds between keep-alive pings to keep connection open. Set to 0 to disable.
* @param {number} [options.retries=0] Number of times to reconnect before failing.
Expand Down

0 comments on commit f67b79c

Please sign in to comment.