46 lines
2.1 KiB
TypeScript
46 lines
2.1 KiB
TypeScript
|
import type { WaitForOptions } from '../../types.js';
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* Wait for an element for the provided amount of
|
||
|
|
* milliseconds to be present within the DOM. Returns true if the selector
|
||
|
|
* matches at least one element that exists in the DOM, otherwise throws an
|
||
|
|
* error. If the reverse flag is true, the command will instead return true
|
||
|
|
* if the selector does not match any elements.
|
||
|
|
*
|
||
|
|
* :::info
|
||
|
|
*
|
||
|
|
* As opposed to other element commands WebdriverIO will not wait for the
|
||
|
|
* element to exist to execute this command.
|
||
|
|
*
|
||
|
|
* :::
|
||
|
|
*
|
||
|
|
* <example>
|
||
|
|
:waitForExistSyncExample.js
|
||
|
|
it('should display a notification message after successful form submit', async () => {
|
||
|
|
const form = await $('form');
|
||
|
|
const notification = await $('.notification');
|
||
|
|
await form.$(".send").click();
|
||
|
|
await notification.waitForExist({ timeout: 5000 });
|
||
|
|
expect(await notification.getText()).to.be.equal('Data transmitted successfully!')
|
||
|
|
});
|
||
|
|
it('should remove a message after successful form submit', async () => {
|
||
|
|
const form = await $('form');
|
||
|
|
const message = await $('.message');
|
||
|
|
await form.$(".send").click();
|
||
|
|
await message.waitForExist({ reverse: true });
|
||
|
|
});
|
||
|
|
* </example>
|
||
|
|
*
|
||
|
|
* @alias element.waitForExist
|
||
|
|
* @param {WaitForOptions=} options waitForEnabled options (optional)
|
||
|
|
* @param {Number=} options.timeout time in ms (default set based on [`waitforTimeout`](/docs/configuration#waitfortimeout) config value)
|
||
|
|
* @param {Boolean=} options.reverse if true it waits for the opposite (default: false)
|
||
|
|
* @param {String=} options.timeoutMsg if exists it overrides the default error message
|
||
|
|
* @param {Number=} options.interval interval between checks (default: `waitforInterval`)
|
||
|
|
* @return {Boolean} true if element exists (or doesn't if flag is set)
|
||
|
|
* @uses utility/waitUntil, state/isExisting
|
||
|
|
* @type utility
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
export declare function waitForExist(this: WebdriverIO.Element, { timeout, interval, reverse, timeoutMsg }?: WaitForOptions): Promise<true>;
|
||
|
|
//# sourceMappingURL=waitForExist.d.ts.map
|