robojerk/codeql-action

Add JSDoc for mockDownloadApi

Browse source
This commit is contained in:
Henry Mercer 2023-01-11 15:25:21 +00:00
parent 4a918790cd
commit 6ba0a36550
3 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/codeql.test.js generated
View file

@ -81,6 +81,12 @@ ava_1.default.beforeEach(() => {
trapCacheDownloadTime: 0,
};
});
/**
* Mocks the API for downloading the bundle tagged `tagName`.
*
* @returns the download URL for the bundle. This can be passed to the tools parameter of
* `codeql.setupCodeQL`.
*/
async function mockDownloadApi({ apiDetails = sampleApiDetails, isPinned, tagName, }) {
var _a;
const platform = process.platform === "win32"

2
lib/codeql.test.js.map
View file

File diff suppressed because one or more lines are too long

6
src/codeql.test.ts
View file

@ -67,6 +67,12 @@ test.beforeEach(() => {
};
});
/**
* Mocks the API for downloading the bundle tagged `tagName`.
*
* @returns the download URL for the bundle. This can be passed to the tools parameter of
* `codeql.setupCodeQL`.
*/
async function mockDownloadApi({
apiDetails = sampleApiDetails,
isPinned,