Skip to content

Commit df15828

Browse files
authored
Update API overview page (#791)
1 parent 4735221 commit df15828

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

pages/docs/manual/latest/api.mdx

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
# Overview
22

3-
## New Standard Library
3+
## ReScript Core
44

5-
[ReScript Core](api/core) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode.
5+
[Core](api/core) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode.
66

7-
## Other Modules
7+
In ReScript 11, it is shipped as a separate npm package `@rescript/core` that is added to your project as per the [installation instructions](http://localhost:3000/docs/manual/latest/installation). In future ReScript versions, it will be included with the `rescript` npm package itself.
88

9-
ReScript ships 3 modules in its standard library.
9+
## Additional Libraries
1010

11-
- [Js](api/js): bindings for all your familiar JavaScript APIs.
12-
- [Belt](api/belt): extra collections and helpers not available in JavaScript.
13-
- [Dom](api/dom): Dom related types and modules.
11+
ReScript ships with these two additional modules in its standard library:
1412

15-
Usage heuristics:
13+
- [Belt](api/belt): immutable collections and extra helpers not available in JavaScript / [Core](api/core).
14+
- [Dom](api/dom): Dom related types and modules. Contains our standardized types used by various userland DOM bindings.
1615

17-
- Default to using the `Js` module. Most of the APIs in it are runtime-free and compile down to clean, readable JavaScript, which is our priority.
18-
- For other APIs that aren't available in regular JavaScript (and thus don't exist in our `Js` bindings), use Belt. For example, prefer `Js.Array2` over `Belt.Array`.
19-
- The `Dom` module contains our standardized types used by various userland DOM bindings. Due to the complexity of DOM, we don't mind that you ignore this module and build your application-specific DOM bindings.
16+
## Legacy Modules
2017

21-
**Note**: we do not recommend other userland standard library alternatives (unless it's DOM bindings). These cause confusion and split points for the community.
18+
The [Js](api/js) module is superseded by [Core](api/core).

0 commit comments

Comments
 (0)