From dba86159147e6447af5bf47a2b0bd720a7aea70c Mon Sep 17 00:00:00 2001 From: Fabian Scheidt Date: Tue, 15 Feb 2022 15:59:08 +0100 Subject: [PATCH] docs: add note on client error handling to documentation --- docs/client.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/client.md b/docs/client.md index 7ff9f37..e58b171 100644 --- 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