Update jsdocs

This commit is contained in:
rejas
2021-08-01 09:53:28 +02:00
parent ae3d552ad7
commit cd18794fca
5 changed files with 27 additions and 20 deletions

View File

@@ -13,7 +13,9 @@ describe("Weather module", function () {
helpers.setupTimeout(this);
/**
* @param responses
*
* @param {object} responses mocked data to be returned
* @returns {Promise} Resolved once the electron app is started
*/
async function setup(responses) {
app = await helpers.startApplication({
@@ -27,15 +29,18 @@ describe("Weather module", function () {
}
/**
* @param element
*
* @param {string} element css selector
* @returns {Promise<Element>} Promise with the element once it is rendered
*/
async function getElement(element) {
return await app.client.$(element);
}
/**
* @param element
* @param result
* @param {string} element css selector
* @param {string} result Expected text in given selector
* @returns {Promise<boolean>} Promise with True if the text matches
*/
async function getText(element, result) {
const elem = await getElement(element);