robojerk/codeql-action

Merge pull request #1296 from github/edoardo/improve-docs

Browse source 
Improve documentation comment
This commit is contained in:
Edoardo Pirovano 2022-10-12 08:35:01 +01:00 • committed by GitHub
commit e862e8fc76
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
lib/util.js generated
View file

@ -748,8 +748,9 @@ exports.tryGetFolderBytes = 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.

2
lib/util.js.map
View file

File diff suppressed because one or more lines are too long

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.