Skip to content

Commit 8f1dd34

Browse files
committed
fix typos
1 parent 011f1dc commit 8f1dd34

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![GitHub License](https://img.shields.io/github/license/Jobflow-io/effect-playwright)](https://github.com/Jobflow-io/effect-playwright/blob/main/LICENSE)
44
[![Effect: yes](https://img.shields.io/badge/effect-yes-blue)](https://effect.website/)
55

6-
A Playwright wrapper for the Effect ecosystem. This library provides a set of services and layers to interact with Playwright in a type-safe and functional way using Effect.
6+
A Playwright wrapper for the Effect ecosystem. This library provides a set of services and layers to interact with Playwright in a type-safe way using Effect.
77

88
## Installation
99

@@ -77,7 +77,7 @@ await Effect.runPromise(program.pipe(Effect.provide(liveLayer)));
7777

7878
## Accessing Native Playwright
7979

80-
If you need to access functionality from the underlying Playwright objects that isn't directly exposed, you can use the `use` method available on most services (`PlaywrightBrowser`, `PlaywrightPage`, `PlaywrightLocator`).
80+
If you need to access functionality from the underlying Playwright objects that isn't directly exposed, you can use the `use` method available on most services/objects (browsers, pages, locators).
8181

8282
```ts
8383
import { Playwright } from "effect-playwright";
@@ -97,3 +97,5 @@ const program = Effect.gen(function* () {
9797
## Error Handling
9898

9999
All methods return effects that can fail with a `PlaywrightError`. This error wraps the original error from Playwright.
100+
Note that Playwright does not support interruption, so `Effect.timeout` or similar code does not behave like you
101+
might expect. Playwright provides its own `timeout` option for almost every method.

package.json

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,16 @@
22
"name": "effect-playwright",
33
"type": "module",
44
"version": "0.1.0",
5-
"description": "A effect based Playwright library.",
6-
"main": "./dist/index.mjs",
7-
"module": "./dist/index.mjs",
5+
"description": "An Effect-based Playwright library.",
86
"author": "Jobflow GmbH",
97
"license": "ISC",
10-
"homepage": "https://github.com/jobflow/effect-playwright",
8+
"homepage": "https://github.com/Jobflow-io/effect-playwright",
119
"repository": {
1210
"type": "git",
13-
"url": "git+https://github.com/jobflow/effect-playwright.git"
11+
"url": "git+https://github.com/Jobflow-io/effect-playwright.git"
1412
},
1513
"bugs": {
16-
"url": "https://github.com/jobflow/effect-playwright/issues"
14+
"url": "https://github.com/Jobflow-io/effect-playwright/issues"
1715
},
1816
"exports": {
1917
".": "./dist/index.mjs",

src/experimental/environment.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import type { BrowserType, LaunchOptions } from "playwright-core";
55
import type { PlaywrightError } from "../errors";
66

77
/**
8-
* Most of the time you want to use the same kind of browser and configuration every time you use playwright.
8+
* Most of the time you want to use the same kind of browser and configuration every time you use Playwright.
99
* `PlaywrightEnvironment` is a service that allows you to configure how browsers are launched once. You can then
1010
* use {@link PlaywrightEnvironment.browser} to start browsers scoped to the current lifetime. They will be closed when the scope is closed.
1111
*
1212
* You can use {@link PlaywrightEnvironment.withBrowser} to provide the `PlaywrightBrowser` service to the wrapped effect. This
13-
* also allows you to re-use the same browser how many times you want.
13+
* also allows you to re-use the same browser as many times as you want.
1414
*
1515
* @since 0.1.0
1616
* @category tag
@@ -67,7 +67,7 @@ export const layer = (browser: BrowserType, launchOptions?: LaunchOptions) => {
6767
};
6868

6969
/**
70-
* Provides a scoped `PlaywrightBrowser` service, allowing you to access the browser from the context (eg. by yielding `PlaywrightBrowser`).
70+
* Provides a scoped `PlaywrightBrowser` service, allowing you to access the browser from the context (e.g. by yielding `PlaywrightBrowser`).
7171
*
7272
* You will need to provide the `PlaywrightEnvironment` layer first.
7373
*

0 commit comments

Comments
 (0)