From 00714900ea1e8ba0a1f87b9f8399001e47f060ec Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Sun, 20 Feb 2022 22:00:41 +0100 Subject: [PATCH] [doc] Update JSDoc comment --- index.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/index.js b/index.js index ec6091a..9093098 100644 --- a/index.js +++ b/index.js @@ -9,9 +9,11 @@ var required = require('requires-port') , windowsDriveLetter = /^[a-zA-Z]:/; /** - * Trim a given string. + * Remove control characters and whitespace from the beginning of a string. * - * @param {String} str String to trim. + * @param {Object|String} str String to trim. + * @returns {String} A new string representing `str` stripped of control + * characters and whitespace from its beginning. * @public */ function trimLeft(str) {