Add JSDoc for mockDownloadApi

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

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,