Skip to content

Commit 6493d82

Browse files
author
Austin Kelleher
committed
Add API docs
1 parent a05c12a commit 6493d82

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# playwright-aws-lambda
22

3-
Support for PlayWright running on AWS Lambda and Google Cloud Functions
3+
Support for PlayWright running on AWS Lambda and Google Cloud Functions.
4+
5+
NOTE: Currently only Chromium is supported.
46

57
## Install
68

@@ -38,6 +40,12 @@ exports.handler = async (event, context) => {
3840
};
3941
```
4042

43+
## API
44+
45+
| Method / Property | Returns | Description |
46+
| ----------------- | ---------------------------------------- | ------------------------------ |
47+
| `launchChromium` | `{!Promise<playwright.ChromiumBrowser>}` | Launches the Chromium browser. |
48+
4149
## Thanks / Credits
4250

4351
This project is based on the work of

0 commit comments

Comments
 (0)