https://github.com/checkly/checkly-playwright-helpers
https://github.com/checkly/checkly-playwright-helpers
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/checkly/checkly-playwright-helpers
- Owner: checkly
- License: mit
- Created: 2024-02-12T15:42:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-28T09:48:22.000Z (about 1 year ago)
- Last Synced: 2025-02-25T10:56:18.555Z (3 months ago)
- Language: TypeScript
- Size: 222 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Checkly Playwright Helpers
`@checkly/playwright-helpers` is included in runtime 2023.09 and later, this library is only meant to be used within [Checkly](https://checklyhq.com) Multistep and Browser checks.
## Installation
`npm i @checkly/playwright-helpers`
## Methods
### markCheckAsDegraded
Marks a check as degraded if:
- The check is failing with soft assertions, or
- The check has no failures
```
import { markCheckAsDegraded } from '@checkly/playwright-helpers'
test("Checkly Multistep", async ({ request }) => {
test.step('Google', () => {
const response = await request.get('https://google.com')
const data = await response.json()
if (data.foo.length > 100) {
markCheckAsDegraded('Foo is too long.')
}
})
})
```
#### Arguments
- `reason` String (optional). Logged when the method is called. Used to identify which method caused the degradation.
### getAPIResponseTime
Gets the request response time.
```
import { getAPIResponseTime } from '@checkly/playwright-helpers'
test("Checkly Multistep", async ({ request }) => {
test.step('Google', () => {
const response = await request.get('https://google.com')
console.log(getAPIResponseTime(response))
})
})
```
#### Arguments
- `response` [APIResponse](https://playwright.dev/docs/api/class-apiresponse) (required). A response from a Playwright API request.
## Support
Feel free to reach out to our customer support if you have any questions [[email protected]](mailto:[email protected]).