Skip to content

rename Prelude to Base and split Base.Types #254

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

Merged
tsnobip merged 9 commits into from
Apr 19, 2026
Merged

rename Prelude to Base and split Base.Types #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bf13a3b
add a script to create the subpackages
tsnobip Apr 19, 2026
04f320a
move to @rescript-webapi npm namespace
tsnobip Apr 19, 2026
90e67c4
remove unused JS files
tsnobip Apr 19, 2026
da91f58
split Prelude.Types into multiple files
tsnobip Apr 19, 2026
1cd74f0
bring back tests
tsnobip Apr 19, 2026
063da70
format
tsnobip Apr 19, 2026
2ff3451
rename prelude to base
tsnobip Apr 19, 2026
3fde9be
disable warning 30
tsnobip Apr 19, 2026
ecd373b
format
tsnobip Apr 19, 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
5 changes: 2 additions & 3 deletions docs/content/docs/contributing/api-modelling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,8 @@ mutable fillStyle: fillStyle
When we wish to read and write the `fillStyle` property, we can use a helper module to lift the type to an actual ReScript variant:

export const fillStyleModule = `
open Prelude
open CanvasAPI
open DOMAPI
open WebApiCanvas
open WebApiDOM
external fromString: string => fillStyle = "%identity"
external fromCanvasGradient: canvasGradient => fillStyle = "%identity"
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/philosophy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ let element: element = document->Document.createElement( ~localName = "div")
let node: node = element->Element.asNode
```

Any other conversions can be performed using the `Prelude.unsafeConversation` helper. This should be done with caution, as it can lead to runtime errors.
Any other conversions can be performed using the `Base.unsafeConversation` helper. This should be done with caution, as it can lead to runtime errors.

```ReScript
open WebAPI

let element: element = document->Document.createElement( ~localName = "div")
// This is potentially unsafe, as the type system cannot guarantee the conversion
let divElement: htmlDivElement = element->Prelude.unsafeConversation
let divElement: htmlDivElement = element->Base.unsafeConversation
```
Loading