c4803e4a37
🤖 I have created a release *beep* *boop* --- <details><summary>ng-schematics: 0.1.0</summary> ## 0.1.0 (2022-11-23) ### Features * **ng-schematics:** Release @puppeteer/ng-schematics ([#9244](https://github.com/puppeteer/puppeteer/issues/9244)) ([be33929
](be33929770
)) </details> <details><summary>puppeteer: 19.3.0</summary> ## [19.3.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.2.2...puppeteer-v19.3.0) (2022-11-23) ### Miscellaneous Chores * **puppeteer:** Synchronize puppeteer versions ### Dependencies * The following workspace dependencies were updated * dependencies * puppeteer-core bumped from 19.2.2 to 19.3.0 </details> <details><summary>puppeteer-core: 19.3.0</summary> ## [19.3.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.2.2...puppeteer-core-v19.3.0) (2022-11-23) ### Features * **puppeteer-core:** Infer element type from complex selector ([#9253](https://github.com/puppeteer/puppeteer/issues/9253)) ([bef1061
](bef1061c06
)) * **puppeteer-core:** update Chrome launcher flags ([#9239](https://github.com/puppeteer/puppeteer/issues/9239)) ([ae87bfc
](ae87bfc2b4
)) ### Bug Fixes * remove boundary conditions for visibility ([#9249](https://github.com/puppeteer/puppeteer/issues/9249)) ([e003513
](e003513c0c
)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
96 lines
2.5 KiB
Markdown
96 lines
2.5 KiB
Markdown
---
|
|
sidebar_label: Page.exposeFunction
|
|
---
|
|
|
|
# Page.exposeFunction() method
|
|
|
|
The method adds a function called `name` on the page's `window` object. When called, the function executes `puppeteerFunction` in node.js and returns a `Promise` which resolves to the return value of `puppeteerFunction`.
|
|
|
|
If the puppeteerFunction returns a `Promise`, it will be awaited.
|
|
|
|
:::note
|
|
|
|
Functions installed via `page.exposeFunction` survive navigations.
|
|
|
|
:::note
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Page {
|
|
exposeFunction(
|
|
name: string,
|
|
pptrFunction:
|
|
| Function
|
|
| {
|
|
default: Function;
|
|
}
|
|
): Promise<void>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| ------------ | ---------------------------------- | -------------------------------------------------------------- |
|
|
| name | string | Name of the function on the window object |
|
|
| pptrFunction | Function \| { default: Function; } | Callback function which will be called in Puppeteer's context. |
|
|
|
|
**Returns:**
|
|
|
|
Promise<void>
|
|
|
|
## Example 1
|
|
|
|
An example of adding an `md5` function into the page:
|
|
|
|
```ts
|
|
const puppeteer = require('puppeteer');
|
|
const crypto = require('crypto');
|
|
|
|
(async () => {
|
|
const browser = await puppeteer.launch();
|
|
const page = await browser.newPage();
|
|
page.on('console', msg => console.log(msg.text()));
|
|
await page.exposeFunction('md5', text =>
|
|
crypto.createHash('md5').update(text).digest('hex')
|
|
);
|
|
await page.evaluate(async () => {
|
|
// use window.md5 to compute hashes
|
|
const myString = 'PUPPETEER';
|
|
const myHash = await window.md5(myString);
|
|
console.log(`md5 of ${myString} is ${myHash}`);
|
|
});
|
|
await browser.close();
|
|
})();
|
|
```
|
|
|
|
## Example 2
|
|
|
|
An example of adding a `window.readfile` function into the page:
|
|
|
|
```ts
|
|
const puppeteer = require('puppeteer');
|
|
const fs = require('fs');
|
|
|
|
(async () => {
|
|
const browser = await puppeteer.launch();
|
|
const page = await browser.newPage();
|
|
page.on('console', msg => console.log(msg.text()));
|
|
await page.exposeFunction('readfile', async filePath => {
|
|
return new Promise((resolve, reject) => {
|
|
fs.readFile(filePath, 'utf8', (err, text) => {
|
|
if (err) reject(err);
|
|
else resolve(text);
|
|
});
|
|
});
|
|
});
|
|
await page.evaluate(async () => {
|
|
// use window.readfile to read contents of a file
|
|
const content = await window.readfile('/etc/hosts');
|
|
console.log(content);
|
|
});
|
|
await browser.close();
|
|
})();
|
|
```
|