thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add AbortSignal to waitForFunction (#10078)

Browse Source 
Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com>
This commit is contained in:
Alex Rudenko 2023-04-26 10:50:08 +02:00 committed by GitHub
parent 159513c8db
commit 4dd4cb9292
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api/puppeteer.framewaitforfunctionoptions.md
View File

@ -15,4 +15,5 @@ export interface FrameWaitForFunctionOptions
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| -------- | --------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | -------- | --------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| polling | <code>optional</code> | 'raf' \| 'mutation' \| number | <p>An interval at which the <code>pageFunction</code> is executed, defaults to <code>raf</code>. If <code>polling</code> is a number, then it is treated as an interval in milliseconds at which the function would be executed. If <code>polling</code> is a string, then it can be one of the following values:</p><p>- <code>raf</code> - to constantly execute <code>pageFunction</code> in <code>requestAnimationFrame</code> callback. This is the tightest polling mode which is suitable to observe styling changes.</p><p>- <code>mutation</code> - to execute <code>pageFunction</code> on every DOM mutation.</p> | | | polling | <code>optional</code> | 'raf' \| 'mutation' \| number | <p>An interval at which the <code>pageFunction</code> is executed, defaults to <code>raf</code>. If <code>polling</code> is a number, then it is treated as an interval in milliseconds at which the function would be executed. If <code>polling</code> is a string, then it can be one of the following values:</p><p>- <code>raf</code> - to constantly execute <code>pageFunction</code> in <code>requestAnimationFrame</code> callback. This is the tightest polling mode which is suitable to observe styling changes.</p><p>- <code>mutation</code> - to execute <code>pageFunction</code> on every DOM mutation.</p> | |
| signal | <code>optional</code> | AbortSignal | A signal object that allows you to cancel a waitForFunction call. | |
| timeout | <code>optional</code> | number | Maximum time to wait in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable the timeout. Puppeteer's default timeout can be changed using [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md). | | | timeout | <code>optional</code> | number | Maximum time to wait in milliseconds. Defaults to <code>30000</code> (30 seconds). Pass <code>0</code> to disable the timeout. Puppeteer's default timeout can be changed using [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md). | |

4
packages/puppeteer-core/src/common/Frame.ts
View File

@ -64,6 +64,10 @@ export interface FrameWaitForFunctionOptions {
* using {@link Page.setDefaultTimeout}. * using {@link Page.setDefaultTimeout}.
*/ */
timeout?: number; timeout?: number;
/**
* A signal object that allows you to cancel a waitForFunction call.
*/
signal?: AbortSignal;
} }
/** /**

16
test/src/waittask.spec.ts
View File

@ -330,6 +330,22 @@ describe('waittask specs', function () {
}); });
await watchdog; await watchdog;
}); });
it('should be cancellable', async () => {
const {page, server} = getTestState();
await page.goto(server.EMPTY_PAGE);
const abortController = new AbortController();
const task = page.waitForFunction(
() => {
return (globalThis as any).__done;
},
{
signal: abortController.signal,
}
);
abortController.abort();
await expect(task).rejects.toThrow(/aborted/);
});
}); });
describe('Page.waitForTimeout', () => { describe('Page.waitForTimeout', () => {