verdnatura-mirror
/
node-ldapjs
mirror of https://github.com/ldapjs/node-ldapjs.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document `reconnect` option. (#504) 

* Fix typo.

*  Document `reconnect` option.

Fixes #392
This commit is contained in:
Simon Olofsson 2019-08-27 01:16:42 +02:00 committed by James Sumners
parent f1acfee9de
commit 736b570bd6
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/client.md
View File

@ -32,6 +32,7 @@ client is:
|tlsOptions |Additional options passed to TLS connection layer when connecting via `ldaps://` (See: The TLS docs for node.js)| |tlsOptions |Additional options passed to TLS connection layer when connecting via `ldaps://` (See: The TLS docs for node.js)|
|idleTimeout |Milliseconds after last activity before client emits idle event| |idleTimeout |Milliseconds after last activity before client emits idle event|
|strictDN |Force strict DN parsing for client methods (Default is true)| |strictDN |Force strict DN parsing for client methods (Default is true)|
|reconnect |Try to reconnect when the connection gets lost (Default is false)|
### Note On Logger ### Note On Logger
@ -48,9 +49,17 @@ Known compatible loggers are:
## Connection management ## Connection management
As LDAP is a stateful protocol (as opposed to HTTP), having connections torn As LDAP is a stateful protocol (as opposed to HTTP), having connections torn
down from underneath you is can be difficult to deal with. Several mechanisms down from underneath you can be difficult to deal with. Several mechanisms
have been provided to mitigate this trouble. have been provided to mitigate this trouble.
### Reconnect
You can provide a Boolean option indicating if a reconnect should be tried. For
more sophisticated control, you can provide an Object with the properties
`initialDelay` (default: `100`), `maxDelay` (default: `10000`) and
`failAfter` (default: `Infinity`).
After the reconnect you maybe need to [bind](#bind) again.
## Common patterns ## Common patterns