Merge pull request #786 from FabianScheidt/error-handling-documentation

2022-02-23 23:59:40 -06:00 · 2022-02-23 23:59:40 -06:00 · b828515c2e
parent 349c261911 dba8615914
commit b828515c2e
1 changed files with 7 additions and 0 deletions
--- a/docs/client.md
+++ b/docs/client.md
@ -63,6 +63,13 @@ Known compatible loggers are:
 + [Bunyan](https://www.npmjs.com/package/bunyan)
 + [Pino](https://www.npmjs.com/package/pino)

+
+### Note On Error Handling
+
+The client is an `EventEmitter`. If you don't register an error handler and
+e.g. a connection error occurs, Node.js will print a stack trace and exit the
+process ([reference](https://nodejs.org/api/events.html#error-events)).
+
 ## Connection management

 As LDAP is a stateful protocol (as opposed to HTTP), having connections torn