From c7514b9e33eff1ab2c8f4d41272c129dc9198ec9 Mon Sep 17 00:00:00 2001
From: Darrel O'Pry <darrel.opry@gmail.com>
Date: Fri, 16 Mar 2018 02:58:32 -0400
Subject: [PATCH] chore: document client.errorResponse

---
 lib/client.js | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/client.js b/lib/client.js
index 45c2909..8478f60 100644
--- a/lib/client.js
+++ b/lib/client.js
@@ -1122,6 +1122,14 @@ class Client extends EventEmitter {
     this._transport.send(buffer.buffer, buffer.offset, receiver);
   }
 
+  /**
+   * Send an errorResponse for a confirmedService.
+   * @param {string} receiver ip address of the service initiator
+   * @param {enum.ConfirmedServices} service the initiated service the generated the error.
+   * @param {number} invokeId  the 'invoke-id' from the confirmed service request to which the error is a response.
+   * @param {enum.ErrorClasses} errorClass
+   * @param {enum.ErrorCode} errorCode
+   */
   errorResponse(receiver, service, invokeId, errorClass, errorCode) {
     const buffer = this._getBuffer();
     baNpdu.encode(buffer, baEnum.NpduControls.PRIORITY_NORMAL_MESSAGE, receiver);