Add JSDoc to test/*

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
This commit is contained in:
Matthew Nickson 2022-04-22 23:24:14 +01:00
parent 9130b3762c
commit b641c8a878
No known key found for this signature in database
GPG key ID: BF229DCFD4748E05

View file

@ -284,6 +284,11 @@ describe("Init", () => {
}); });
}); });
/**
* Test login
* @param {string} username
* @param {string} password
*/
async function login(username, password) { async function login(username, password) {
await input(page, "#floatingInput", username); await input(page, "#floatingInput", username);
await input(page, "#floatingPassword", password); await input(page, "#floatingPassword", password);
@ -291,6 +296,13 @@ async function login(username, password) {
await sleep(5000); await sleep(5000);
} }
/**
* Click on an element on the page
* @param {Page} page Puppeteer page instance
* @param {string} selector
* @param {number} elementIndex
* @returns {Promise<any>}
*/
async function click(page, selector, elementIndex = 0) { async function click(page, selector, elementIndex = 0) {
await page.waitForSelector(selector, { await page.waitForSelector(selector, {
timeout: 5000, timeout: 5000,
@ -300,6 +312,12 @@ async function click(page, selector, elementIndex = 0) {
}, selector, elementIndex); }, selector, elementIndex);
} }
/**
* Input text into selected field
* @param {Page} page Puppeteer page instance
* @param {string} selector
* @param {string} text Text to input
*/
async function input(page, selector, text) { async function input(page, selector, text) {
await page.waitForSelector(selector, { await page.waitForSelector(selector, {
timeout: 5000, timeout: 5000,