regen docs

Author: baileympearson

README.md

@@ -39,12 +39,12 @@ modify an existing installation) and select *Common Tools for Visual C++* during
 Only the following version combinations with the [MongoDB Node.js
 Driver](https://github.com/mongodb/node-mongodb-native) are considered stable.
 
-| | `[email protected]` | `[email protected]` |
+|               | `[email protected]` | `[email protected]` |
 | ------------- | -------------- | -------------- |
-| `[email protected]` | N/A | ✓ |
-| `[email protected]` | ✓ | ✓ |
-| `[email protected]` | ✓ | ✓ |
-| `[email protected]` | ✓ | N/A |
+| `[email protected]` | N/A            | ✓              |
+| `[email protected]` | ✓              | ✓              |
+| `[email protected]` | ✓              | ✓              |
+| `[email protected]` | ✓              | N/A            |
 
 ### Installation
 
@@ -131,7 +131,7 @@ MongoDB Node drivers (<code>mongodb&lt;4.0</code>).</p>
 ## Functions
 
 <dl>
-<dt><a href="#checkPassword">checkPassword(username, password, service, [defaultRealm], [callback])</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#checkPassword">checkPassword(username, password, service, [defaultRealm])</a> ⇒ <code>Promise</code></dt>
 <dd><p>This function provides a simple way to verify that a user name and password
 match those normally used for Kerberos authentication.
 It does this by checking that the supplied user name and password can be
@@ -146,14 +146,14 @@ has the correct realms and KDCs listed.</p>
 only be used for testing. Do not use this in any production system - your
 security could be compromised if you do.</p>
 </dd>
-<dt><a href="#principalDetails">principalDetails(service, hostname, [callback])</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#principalDetails">principalDetails(service, hostname)</a> ⇒ <code>Promise</code></dt>
 <dd><p>This function returns the service principal for the server given a service type and hostname.</p>
 <p>Details are looked up via the <code>/etc/keytab</code> file.</p>
 </dd>
-<dt><a href="#initializeClient">initializeClient(service, [options], [callback])</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#initializeClient">initializeClient(service, [options])</a> ⇒ <code>Promise</code></dt>
 <dd><p>Initializes a context for client-side authentication with the given service principal.</p>
 </dd>
-<dt><a href="#initializeServer">initializeServer(service, [callback])</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#initializeServer">initializeServer(service)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Initializes a context for server-side authentication with the given service principal.</p>
 </dd>
 </dl>
@@ -163,107 +163,92 @@ security could be compromised if you do.</p>
 ## KerberosClient
 **Properties**
 
-| Name | Type | Description |
-| --- | --- | --- |
-| username | <code>string</code> | The username used for authentication |
-| response | <code>string</code> | The last response received during authentication steps |
-| responseConf | <code>string</code> | Indicates whether confidentiality was applied or not (GSSAPI only) |
-| contextComplete | <code>boolean</code> | Indicates that authentication has successfully completed or not |
+| Name            | Type                 | Description                                                        |
+| --------------- | -------------------- | ------------------------------------------------------------------ |
+| username        | <code>string</code>  | The username used for authentication                               |
+| response        | <code>string</code>  | The last response received during authentication steps             |
+| responseConf    | <code>string</code>  | Indicates whether confidentiality was applied or not (GSSAPI only) |
+| contextComplete | <code>boolean</code> | Indicates that authentication has successfully completed or not    |
 
 
 * [KerberosClient](#KerberosClient)
 
-    * [.step(challenge, [callback])](#KerberosClient+step)
+    * [.step(challenge)](#KerberosClient+step)
 
-    * [.wrap(challenge, [options], [callback])](#KerberosClient+wrap)
+    * [.wrap(challenge, [options])](#KerberosClient+wrap)
 
-    * [.unwrap(challenge, [callback])](#KerberosClient+unwrap)
+    * [.unwrap(challenge)](#KerberosClient+unwrap)
 
 
 <a name="KerberosClient+step"></a>
 
-### *kerberosClient*.step(challenge, [callback])
+### *kerberosClient*.step(challenge)
 
-| Param | Type | Description |
-| --- | --- | --- |
+| Param     | Type                | Description                                                                                |
+| --------- | ------------------- | ------------------------------------------------------------------------------------------ |
 | challenge | <code>string</code> | A string containing the base64-encoded server data (which may be empty for the first step) |
-| [callback] | <code>function</code> |  |
 
 Processes a single kerberos client-side step using the supplied server challenge.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="KerberosClient+wrap"></a>
 
-### *kerberosClient*.wrap(challenge, [options], [callback])
+### *kerberosClient*.wrap(challenge, [options])
 
-| Param | Type | Description |
-| --- | --- | --- |
-| challenge | <code>string</code> | The response returned after calling `unwrap` |
-| [options] | <code>object</code> | Optional settings |
-| [options.user] | <code>string</code> | The user to authorize |
+| Param             | Type                 | Description                                                  |
+| ----------------- | -------------------- | ------------------------------------------------------------ |
+| challenge         | <code>string</code>  | The response returned after calling `unwrap`                 |
+| [options]         | <code>object</code>  | Optional settings                                            |
+| [options.user]    | <code>string</code>  | The user to authorize                                        |
 | [options.protect] | <code>boolean</code> | Indicates if the wrap should request message confidentiality |
-| [callback] | <code>function</code> |  |
 
 Perform the client side kerberos wrap step.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="KerberosClient+unwrap"></a>
 
-### *kerberosClient*.unwrap(challenge, [callback])
+### *kerberosClient*.unwrap(challenge)
 
-| Param | Type | Description |
-| --- | --- | --- |
+| Param     | Type                | Description                                        |
+| --------- | ------------------- | -------------------------------------------------- |
 | challenge | <code>string</code> | A string containing the base64-encoded server data |
-| [callback] | <code>function</code> |  |
 
 Perform the client side kerberos unwrap step
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="KerberosServer"></a>
 
 ## KerberosServer
 **Properties**
 
-| Name | Type | Description |
-| --- | --- | --- |
-| username | <code>string</code> | The username used for authentication |
-| response | <code>string</code> | The last response received during authentication steps |
-| targetName | <code>string</code> | The target used for authentication |
+| Name            | Type                 | Description                                                     |
+| --------------- | -------------------- | --------------------------------------------------------------- |
+| username        | <code>string</code>  | The username used for authentication                            |
+| response        | <code>string</code>  | The last response received during authentication steps          |
+| targetName      | <code>string</code>  | The target used for authentication                              |
 | contextComplete | <code>boolean</code> | Indicates that authentication has successfully completed or not |
 
 <a name="KerberosServer+step"></a>
 
-### *kerberosServer*.step(challenge, [callback])
+### *kerberosServer*.step(challenge)
 
-| Param | Type | Description |
-| --- | --- | --- |
+| Param     | Type                | Description                                        |
+| --------- | ------------------- | -------------------------------------------------- |
 | challenge | <code>string</code> | A string containing the base64-encoded client data |
-| [callback] | <code>function</code> |  |
 
 Processes a single kerberos server-side step using the supplied client data.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
-<a name="MongoAuthProcess"></a>
-
-## ~~MongoAuthProcess~~
-***This class will be removed in an upcoming major release.***
-
-A class that was used for MongoDB kerberos authentication with legacy
-MongoDB Node drivers (`mongodb<4.0`).
-
-Not intended for direct use.
-
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="checkPassword"></a>
 
-## checkPassword(username, password, service, [defaultRealm], [callback])
+## checkPassword(username, password, service, [defaultRealm])
 
-| Param | Type | Description |
-| --- | --- | --- |
-| username | <code>string</code> | The Kerberos user name. If no realm is supplied, then the `defaultRealm` will be used. |
-| password | <code>string</code> | The password for the user. |
-| service | <code>string</code> | The Kerberos service to check access for. |
-| [defaultRealm] | <code>string</code> | The default realm to use if one is not supplied in the user argument. |
-| [callback] | <code>function</code> |  |
+| Param          | Type                | Description                                                                            |
+| -------------- | ------------------- | -------------------------------------------------------------------------------------- |
+| username       | <code>string</code> | The Kerberos user name. If no realm is supplied, then the `defaultRealm` will be used. |
+| password       | <code>string</code> | The password for the user.                                                             |
+| service        | <code>string</code> | The Kerberos service to check access for.                                              |
+| [defaultRealm] | <code>string</code> | The default realm to use if one is not supplied in the user argument.                  |
 
 This function provides a simple way to verify that a user name and password
 match those normally used for Kerberos authentication.
@@ -281,47 +266,44 @@ IMPORTANT: This method is vulnerable to KDC spoofing attacks and it should
 only be used for testing. Do not use this in any production system - your
 security could be compromised if you do.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="principalDetails"></a>
 
-## principalDetails(service, hostname, [callback])
+## principalDetails(service, hostname)
 
-| Param | Type | Description |
-| --- | --- | --- |
-| service | <code>string</code> | The Kerberos service type for the server. |
-| hostname | <code>string</code> | The hostname of the server. |
-| [callback] | <code>function</code> |  |
+| Param    | Type                | Description                               |
+| -------- | ------------------- | ----------------------------------------- |
+| service  | <code>string</code> | The Kerberos service type for the server. |
+| hostname | <code>string</code> | The hostname of the server.               |
 
 This function returns the service principal for the server given a service type and hostname.
 
 Details are looked up via the `/etc/keytab` file.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="initializeClient"></a>
 
-## initializeClient(service, [options], [callback])
+## initializeClient(service, [options])
 
-| Param | Type | Description |
-| --- | --- | --- |
-| service | <code>string</code> | A string containing the service principal in the form 'type@fqdn' (e.g. '[email protected]'). |
-| [options] | <code>object</code> | Optional settings |
-| [options.principal] | <code>string</code> | Optional string containing the client principal in the form 'user@realm' (e.g. '[email protected]'). |
-| [options.flags] | <code>number</code> | Optional integer used to set GSS flags. (e.g.  `GSS_C_DELEG_FLAG\|GSS_C_MUTUAL_FLAG\|GSS_C_SEQUENCE_FLAG` will allow for forwarding credentials to the remote host) |
-| [options.mechOID] | <code>number</code> | Optional GSS mech OID. Defaults to None (GSS_C_NO_OID). Other possible values are `GSS_MECH_OID_KRB5`, `GSS_MECH_OID_SPNEGO`. |
-| [callback] | <code>function</code> |  |
+| Param               | Type                | Description                                                                                                                                                         |
+| ------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| service             | <code>string</code> | A string containing the service principal in the form 'type@fqdn' (e.g. '[email protected]').                                                                     |
+| [options]           | <code>object</code> | Optional settings                                                                                                                                                   |
+| [options.principal] | <code>string</code> | Optional string containing the client principal in the form 'user@realm' (e.g. '[email protected]').                                                                 |
+| [options.flags]     | <code>number</code> | Optional integer used to set GSS flags. (e.g.  `GSS_C_DELEG_FLAG\|GSS_C_MUTUAL_FLAG\|GSS_C_SEQUENCE_FLAG` will allow for forwarding credentials to the remote host) |
+| [options.mechOID]   | <code>number</code> | Optional GSS mech OID. Defaults to None (GSS_C_NO_OID). Other possible values are `GSS_MECH_OID_KRB5`, `GSS_MECH_OID_SPNEGO`.                                       |
 
 Initializes a context for client-side authentication with the given service principal.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise  
 <a name="initializeServer"></a>
 
-## initializeServer(service, [callback])
+## initializeServer(service)
 
-| Param | Type | Description |
-| --- | --- | --- |
+| Param   | Type                | Description                                                                                     |
+| ------- | ------------------- | ----------------------------------------------------------------------------------------------- |
 | service | <code>string</code> | A string containing the service principal in the form 'type@fqdn' (e.g. '[email protected]'). |
-| [callback] | <code>function</code> |  |
 
 Initializes a context for server-side authentication with the given service principal.
 
-**Returns**: <code>Promise</code> - returns Promise if no callback passed  
+**Returns**: <code>Promise</code> - returns Promise