Skip to content

Commit c249724

Browse files
committed
Add JSDoc comment to runCliJson
1 parent 61b5859 commit c249724

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

src/codeql.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,6 +1131,15 @@ async function runCli(
11311131
}
11321132
}
11331133

1134+
/**
1135+
* Wraps the command executor {@link runCli} and parses the JSON output.
1136+
* @param cmd The command to run.
1137+
* @param args The arguments to pass to the command.
1138+
* @param opts The options for running the command.
1139+
* @param opts.stdin Optional string to pass to the command's standard input.
1140+
* @param opts.noStreamStdout Optional boolean to indicate whether to stream the command's standard output.
1141+
* @returns The parsed JSON output from the command.
1142+
*/
11341143
async function runCliJson<T>(
11351144
cmd: string,
11361145
args: string[] = [],

0 commit comments

Comments
 (0)