@luminati-io/webdriverio8
Version:
Next-gen browser and mobile automation test framework for Node.js
87 lines (85 loc) • 4.44 kB
JavaScript
/**
*
* Wait for an element for the provided amount of
* milliseconds to be stable (not animating). Returns true if the selector
* matches at least one element that is stable 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 stable elements.
*
* __Note:__ it's best to disable animations instead of using this command
*
* <example>
:index.html
<head>
<style>
div {
width: 200px;
height: 200px;
background-color: red;
}
#has-animation {
animation: 3s 0s alternate slidein;
}
\@keyframes slidein {
from {
margin-left: 100%;
width: 300%;
}
to {
margin-left: 0%;
width: 100%;
}
}
</style>
</head>
<body>
<div #has-animation></div>
<div #has-no-animation></div>
</body>
:waitForStable.js
it('should detect that element is instable and will wait for the element to become stable', async () => {
const elem = await $('#has-animation')
await elem.waitForStable({ timeout: 3000 });
});
it('should detect that element is stable and will not wait', async () => {
const elem = await $('#has-no-animation')
await elem.waitForStable();
});
* </example>
*
* @alias element.waitForStable
* @param {WaitForOptions=} options waitForStable options (optional)
* @param {Number=} options.timeout time in ms (default: 500)
* @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 is stable
* @uses utility/waitUntil, state/isStable
* @type utility
*
*/
export async function waitForStable({ timeout = this.options.waitforTimeout, interval = this.options.waitforInterval, reverse = false, timeoutMsg = `element ("${this.selector}") still ${reverse ? '' : 'not '}stable after ${timeout}ms` } = {}) {
let errorMsg;
await this.waitUntil(async () => {
try {
return reverse !== await this.isStable();
}
catch (error) {
if (error instanceof Error) {
errorMsg = error.message;
}
else if (typeof error === 'string') {
errorMsg = error;
}
else {
errorMsg = 'The waitForStable command got an unknown error';
}
// fail early
return !reverse;
}
}, { timeout, interval, timeoutMsg });
if (errorMsg) {
throw Error(errorMsg);
}
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2FpdEZvclN0YWJsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21tYW5kcy9lbGVtZW50L3dhaXRGb3JTdGFibGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUE7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0E2REc7QUFDSCxNQUFNLENBQUMsS0FBSyxVQUFVLGFBQWEsQ0FFL0IsRUFDSSxPQUFPLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxjQUFjLEVBQ3JDLFFBQVEsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsRUFDdkMsT0FBTyxHQUFHLEtBQUssRUFDZixVQUFVLEdBQUcsYUFBYSxJQUFJLENBQUMsUUFBUSxZQUFZLE9BQU8sQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxNQUFNLGdCQUFnQixPQUFPLElBQUksS0FDbkYsRUFBRTtJQUV0QixJQUFJLFFBQWlCLENBQUE7SUFFckIsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUNoQixLQUFLLElBQUksRUFBRTtRQUNQLElBQUksQ0FBQztZQUNELE9BQU8sT0FBTyxLQUFLLE1BQU0sSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFBO1FBQzVDLENBQUM7UUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1lBQ2IsSUFBSSxLQUFLLFlBQVksS0FBSyxFQUFFLENBQUM7Z0JBQ3pCLFFBQVEsR0FBRyxLQUFLLENBQUMsT0FBTyxDQUFBO1lBQzVCLENBQUM7aUJBQU0sSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztnQkFDbkMsUUFBUSxHQUFHLEtBQUssQ0FBQTtZQUNwQixDQUFDO2lCQUFNLENBQUM7Z0JBQ0osUUFBUSxHQUFHLGdEQUFnRCxDQUFBO1lBQy9ELENBQUM7WUFDRCxhQUFhO1lBQ2IsT0FBTyxDQUFDLE9BQU8sQ0FBQTtRQUNuQixDQUFDO0lBQ0wsQ0FBQyxFQUNELEVBQUUsT0FBTyxFQUFFLFFBQVEsRUFBRSxVQUFVLEVBQUUsQ0FDcEMsQ0FBQTtJQUVELElBQUksUUFBUSxFQUFFLENBQUM7UUFDWCxNQUFNLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUN6QixDQUFDO0FBQ0wsQ0FBQyJ9