Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-307

Better documentation of the MongoClient.connect options

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Major - P3 Major - P3
    • 2.0.6
    • Affects Version/s: None
    • Component/s: None
    • Labels:

      Currently, IMO, the documentation for the connect options is quite vague. I would like to see much more descriptive explanations of the various options. Examples:

      "numberOfRetries

      {Number, default:5}

      , number of retries off connection." - Not really sure what this means - I'm assuming that it means the connection will be abandoned after 5 failed retries? If so, what happens to the connection? Is it reconnected?

      "retryMiliSeconds

      {Number, default:5000}

      , number of milliseconds between retries." - There is a typo in this parameter. Is is a mistake in the code or the documentation? If it's a hardcoded type please confirm this in the documentation.

      "ha

      {Boolean, default:true}

      , turn on high availability, attempts to reconnect to down proxies" - What does 'attempts to reconnect to down proxies' mean?

            Assignee:
            christkv Christian Amor Kvalheim
            Reporter:
            bgsosh@gmail.com Scott Lowe
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: