doc(github-like): update types

This commit is contained in:
AJ ONeal
2024-06-05 08:18:50 +00:00
parent e54262cf13
commit fefeb076f2
2 changed files with 14 additions and 17 deletions

View File

@@ -3,23 +3,20 @@
var ghRelease = require('./github.js'); var ghRelease = require('./github.js');
/** /**
* Gets the releases for 'ripgrep'. This function could be trimmed down and made * Lists Gitea Releases (w/ uploaded assets)
* for use with any github release.
* *
* @param request * @param {any} request
* @param {string} owner * @param {String} owner
* @param {string} repo * @param {String} repo
* @returns {PromiseLike<any> | Promise<any>} * @param {String} baseurl
*/ */
function getAllReleases(request, owner, repo, baseurl) { async function getAllReleases(request, owner, repo, baseurl) {
if (!baseurl) { if (!baseurl) {
return Promise.reject('missing baseurl'); throw new Error('missing baseurl');
} }
return ghRelease(request, owner, repo, baseurl + '/api/v1').then( baseurl = `${baseurl}/api/v1`;
function (all) { let all = await ghRelease(request, owner, repo, baseurl);
return all; return all;
},
);
} }
module.exports = getAllReleases; module.exports = getAllReleases;

View File

@@ -5,10 +5,10 @@ require('dotenv').config();
/** /**
* Lists GitHub Releases (w/ uploaded assets) * Lists GitHub Releases (w/ uploaded assets)
* *
* @param request * @param {any} request
* @param {string} owner * @param {String} owner
* @param {string} repo * @param {String} repo
* @returns {PromiseLike<any> | Promise<any>} * @param {String} [baseurl]
*/ */
async function getAllReleases( async function getAllReleases(
request, request,