fix: jsdoc fixes

Author: vigan-abd

index.js

@@ -10,14 +10,14 @@ const WS2Manager = require('./lib/ws2_manager')
  */
 class BFX {
   /**
-   * @param {object} opts - options
-   * @param {string} opts.apiKey - API key
-   * @param {string} opts.apiSecret - API secret
-   * @param {string} opts.authToken - optional auth option
-   * @param {string} opts.transform - if true, packets are converted to models
-   * @param {string} opts.nonceGenerator - optional
-   * @param {string} opts.ws - ws transport options
-   * @param {string} opts.rest - rest transport options
+   * @param {object} [opts] - options
+   * @param {string} [opts.apiKey] - API key
+   * @param {string} [opts.apiSecret] - API secret
+   * @param {string} [opts.authToken] - optional auth option
+   * @param {string} [opts.company] - optional auth option
+   * @param {boolean} [opts.transform] - if true, packets are converted to models
+   * @param {object} [opts.ws] - ws transport options
+   * @param {object} [opts.rest] - rest transport options
    */
   constructor (opts = {
     apiKey: '',
@@ -68,8 +68,8 @@ class BFX {
   /**
    * Returns a new REST API class instance (cached by version)
    *
-   * @param {number} version - 1 or 2 (default)
-   * @param {object} extraOpts - passed to transport constructor
+   * @param {number} [version] - 1 or 2 (default)
+   * @param {object} [extraOpts] - passed to transport constructor
    * @returns {RESTv1|RESTv2} transport
    */
   rest (version = 2, extraOpts = {}) {
@@ -94,8 +94,8 @@ class BFX {
   /**
    * Returns a new WebSocket API class instance (cached by version)
    *
-   * @param {number} version - 1 or 2 (default)
-   * @param {object} extraOpts - passed to transport constructor
+   * @param {number} [version] - 1 or 2 (default)
+   * @param {object} [extraOpts] - passed to transport constructor
    * @returns {WSv1|WSv2} transport
    */
   ws (version = 2, extraOpts = {}) {

lib/ws2_manager.js

@@ -24,7 +24,7 @@ const reconnectThrottler = new PromiseThrottle({
  * getFreeDataSocket(), or create a new WSv2 instance manually
  *
  * @example
- * const rest = new RESTv2()
+ * const rest = new RESTv2({ transform: true })
  * const details = await rest.symbolDetails()
  * const symbols = details.map(d => `t${d.pair.toUpperCase()}`)
  * const timeFrames = ['1m', '5m', '30m', '1h', '6h']
@@ -82,8 +82,8 @@ class WS2Manager extends EventEmitter {
   /**
    * @param {object} socketArgs - passed to WSv2 constructors
    * @param {object} [authArgs] - cached for all internal socket auth() calls
-   * @param {object} [authArgs.calc] - default 0
-   * @param {object} [authArgs.dms] - default 0
+   * @param {number} [authArgs.calc] - default 0
+   * @param {number} [authArgs.dms] - default 0
    */
   constructor (socketArgs, authArgs = { calc: 0, dms: 0 }) {
     super()
@@ -102,8 +102,8 @@ class WS2Manager extends EventEmitter {
    * Update authentication arguments on all sockets
    *
    * @param {object} args - arguments
-   * @param {object} [args.calc] - calc value
-   * @param {object} [args.dms] - active 4
+   * @param {number} [args.calc] - calc value
+   * @param {number} [args.dms] - active 4
    */
   setAuthArgs (args = {}) {
     this._authArgs = {
@@ -185,10 +185,10 @@ class WS2Manager extends EventEmitter {
    * Does nothing if an apiKey/apiSecret pair are already known.
    *
    * @param {object} args - arguments
-   * @param {object} args.apiKey - saved if not already provided
-   * @param {object} args.apiSecret - saved if not already provided
-   * @param {object} [args.calc] - default 0
-   * @param {object} [args.dms] - dead man switch, active 4
+   * @param {string} args.apiKey - saved if not already provided
+   * @param {string} args.apiSecret - saved if not already provided
+   * @param {number} [args.calc] - default 0
+   * @param {number} [args.dms] - dead man switch, active 4
    */
   auth ({ apiKey, apiSecret, calc, dms } = {}) {
     if (this._socketArgs.apiKey || this._socketArgs.apiSecret) {