Skip to content

[codex] split Event owner types #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jderochervlk wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

[codex] split Event owner types #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f97efdc
refactor: split event owner types
jderochervlk Jun 26, 2026
2b9928b
improving types on hover and codelens
jderochervlk Jun 26, 2026
f6f8edc
add EventTarget to Element
jderochervlk Jun 26, 2026
a5d791f
Move Window type to Base.res
jderochervlk Jun 26, 2026
8d1a36b
move event and eventTarget into Base
jderochervlk Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ and add `@rescript/webapi` to your `rescript.json`:
## Usage

```rescript
let location = WebAPI.Window.current->WebAPI.Window.location
let location = WebAPI.Base.window->WebAPI.Window.location
let href = location.href
location->WebAPI.Location.reload
```
Expand Down
10 changes: 5 additions & 5 deletions docs/content/docs/api-surface.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ add the package to `rescript.json`:
}
```

Use `WebAPI.Window.current` for the browser `window`. Interface-specific methods live on
Use `WebAPI.Base.window` for the browser `window`. Interface-specific methods live on
public modules such as `WebAPI.Window`, `WebAPI.Location`, `WebAPI.Document`,
`WebAPI.Element`, `WebAPI.Request`, and `WebAPI.Response`.

```ReScript
let location = WebAPI.Window.current->WebAPI.Window.location
let location = WebAPI.Base.window->WebAPI.Window.location
let href = location.href

location->WebAPI.Location.reload
Expand All @@ -32,7 +32,7 @@ helper modules.
```ReScript
let req: WebAPI.Request.t = WebAPI.Request.fromURL("https://example.com")
let headers = WebAPI.Headers.make()
let document = WebAPI.Window.current->WebAPI.Window.document
let document = WebAPI.Base.window->WebAPI.Window.document
let element = document->WebAPI.Document.createElement("button")
```

Expand Down Expand Up @@ -243,7 +243,7 @@ let redirect = WebAPI.Response.redirect(~url="/login", ~status=302)
DOM values are operated on through public interface modules.

```ReScript
let document = WebAPI.Window.current->WebAPI.Window.document
let document = WebAPI.Base.window->WebAPI.Window.document

let maybeButton = document
->WebAPI.Document.querySelector("button")
Expand Down Expand Up @@ -271,7 +271,7 @@ let node = element->WebAPI.Element.asNode
`Window.visualViewport` returns a nullable `WebAPI.VisualViewport.t`.

```ReScript
let maybeViewport = WebAPI.Window.current
let maybeViewport = WebAPI.Base.window
->WebAPI.Window.visualViewport
->Null.toOption

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export const rescriptJson = `
After installing the package , you can use bindings for the various Web APIs as defined in [MDN](https://developer.mozilla.org/en-US/docs/Web/API).

export const rescriptSample = `
let location = WebAPI.Window.current->WebAPI.Window.location
let location = WebAPI.Base.window->WebAPI.Window.location

// Access properties using \`.\`
let href = location.href
Expand Down
Loading
Loading