docs: specify return type of objDisplay (#1490)

previously it was incorrectly labeled as `objDisplay(obj: object): void` in `@types/chai`.
chaijs · Dec 5, 2022 · 3a8c49a · 3a8c49a
1 parent b455124
commit 3a8c49a
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lib/chai/utils/objDisplay.js b/lib/chai/utils/objDisplay.js
@@ -19,6 +19,7 @@ var config = require('../config');
  * messages or should be truncated.
  *
  * @param {Mixed} javascript object to inspect
+ * @returns {string} stringified object
  * @name objDisplay
  * @namespace Utils
  * @api public