From 1061b73bc9ac9b1413db384f003b269775c1f9ba Mon Sep 17 00:00:00 2001 From: Ramon Brullo Date: Sun, 14 Jan 2024 10:51:30 +0100 Subject: [PATCH] docs: document parameter in jsDoc --- src/utils/process.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/utils/process.ts b/src/utils/process.ts index 09692cc8..e497a436 100644 --- a/src/utils/process.ts +++ b/src/utils/process.ts @@ -2,7 +2,8 @@ import childProcess from "child_process"; /** * @param command A shell command to execute. - * @returns A promise that resolve to the output of the shell command, or an + * @param trim Whether to trim whitespace from command output. + * @returns A promise that resolve to the output of the shell command, or an * error. * @example const output = await execute("ls -alh"); */ @@ -17,10 +18,10 @@ export default function execute( */ return new Promise(function (resolve, reject) { /** - * @param {Error} error An error triggered during the execution of the + * @param {Error} error An error triggered during the execution of the * childProcess.exec command. * @param {string|Buffer} stdout The result of the shell command execution. - * @param {string|Buffer} stderr The error resulting of the shell command + * @param {string|Buffer} stderr The error resulting of the shell command * execution. * @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback */