Add jsdoc comment to Reader.reverseBuffer() to clarify how it works

pokusew · Dec 28, 2018 · 5a2109f · 5a2109f
1 parent fb8c4e2
commit 5a2109f
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/Reader.js b/src/Reader.js
@@ -47,7 +47,13 @@ class Reader extends EventEmitter {
 
 	pendingLoadAuthenticationKey = {};
 
-	// TODO: better way?
+	/**
+	 * Reverses a copy of a given buffer
+	 * Does NOT mutate the given buffer, returns a reversed COPY
+	 * For mutating reverse use native .reverse() method on a buffer instance
+	 * @param src {Buffer} a Buffer instance
+	 * @returns {Buffer}
+	 */
 	static reverseBuffer(src) {
 
 		const buffer = Buffer.allocUnsafe(src.length);