github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-01-04 13:40:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation comment

Browse Source
This commit is contained in:
Edoardo Pirovano
2022-10-11 22:38:30 +01:00
parent 44edb7c4b5
commit 082bdf06b5
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/util.ts
View File

@@ -899,8 +899,9 @@ export async function tryGetFolderBytes(
* Run a promise for a given amount of time, and if it doesn't resolve within
* that time, call the provided callback and then return undefined.
*
* Note that this does NOT cancel the original promise, so that promise will
* continue in the background even after the timeout has expired.
* Important: This does NOT cancel the original promise, so that promise will
* continue in the background even after the timeout has expired. If the
* original promise hangs, then this will prevent the process terminating.
*
* @param timeoutMs The timeout in milliseconds.
* @param promise The promise to run.