{React.string(`Hello ${name}`)}
+ }
+}
+
+module ClassicModeExample = {
+ // "classic" mode will compile jsx to React.createElement calls
+ @@jsxConfig({version: 4, mode: "classic"})
+
+ @react.component
+ let make = (~name) => {
+ {React.string(`Hello ${name}`)}
+ }
+}
+
+module NoAttributeExample = {
+ // No need for `makeProps` anymore
+ type props = {name: string}
+
+ let make = (props: props) => {
+ {React.string(`Hello ${props.name}`)}
+ }
+}
+
+module ReactInterfaceExample: {
+ @react.component
+ let make: (~name: string, ~age: int=?) => React.element
+} = {
+ @react.component
+ let make = (~name, ~age=0) => {
+
+ {React.string(
+ `Hello ${name}, you are ${Belt.Int.toString(age)} years old.`,
+ )}
+
+ }
+}
+
+module PropTypeInjectionExample = {
+ // Let's assume we have a prop type that we wanna enforce
+ // as our labeled arguments
+ type someoneElsesProps = {isHuman: bool}
+
+ // Here we tell the `react.component` decorator what props to infer.
+ // Useful for e.g. NextJS usage, or to create components that should
+ // comply to certain library component interfaces
+ @react.component(: someoneElsesProps)
+ let make = (~isHuman) => {
+ let msg = switch isHuman {
+ | true => "hello human"
+ | false => "hello fellow computer"
+ }
+ {React.string(msg)}
+ }
+}
+
+module PropSpreadExample = {
+ // Note: This will require @rescript/react 0.11 or later
+ @@jsxConfig({version: 4, mode: "automatic"})
+
+ @react.component
+ let make = () => {
+ let props = {NoAttributeExample.name: "World"}
+
+
+
+```
+
+```js
+import * as React from "react";
+import * as JsxRuntime from "react/jsx-runtime";
+
+function Playground$AutomaticModeExample(props) {
+ return JsxRuntime.jsx("div", {
+ children: "Hello " + props.name + ""
+ });
+}
+
+var AutomaticModeExample = {
+ make: Playground$AutomaticModeExample
+};
+
+function Playground$ClassicModeExample(props) {
+ return React.createElement("div", undefined, "Hello " + props.name + "");
+}
+
+var ClassicModeExample = {
+ make: Playground$ClassicModeExample
+};
+
+function make(props) {
+ return JsxRuntime.jsx("div", {
+ children: "Hello " + props.name + ""
+ });
+}
+
+var NoAttributeExample = {
+ make: make
+};
+
+function Playground$ReactInterfaceExample(props) {
+ var age = props.age;
+ var age$1 = age !== undefined ? age : 0;
+ return JsxRuntime.jsx("div", {
+ children: "Hello " + props.name + ", you are " + String(age$1) + " years old."
+ });
+}
+
+var ReactInterfaceExample = {
+ make: Playground$ReactInterfaceExample
+};
+
+function Playground$PropTypeInjectionExample(props) {
+ var msg = props.isHuman ? "hello human" : "hello fellow computer";
+ return JsxRuntime.jsx("div", {
+ children: msg
+ });
+}
+
+var PropTypeInjectionExample = {
+ make: Playground$PropTypeInjectionExample
+};
+
+function Playground$PropSpreadExample(props) {
+ return JsxRuntime.jsx(make, {
+ name: "World"
+ });
+}
+
+var PropSpreadExample = {
+ make: Playground$PropSpreadExample
+};
+
+var root = JsxRuntime.jsxs("div", {
+ children: [
+ JsxRuntime.jsx(Playground$AutomaticModeExample, {
+ name: "Automatic"
+ }),
+ JsxRuntime.jsx(Playground$ClassicModeExample, {
+ name: "Classic"
+ }),
+ JsxRuntime.jsx(make, {
+ name: "NoAttribute"
+ }),
+ JsxRuntime.jsx(Playground$ReactInterfaceExample, {
+ name: "Interface"
+ }),
+ JsxRuntime.jsx(Playground$PropTypeInjectionExample, {
+ isHuman: true
+ }),
+ JsxRuntime.jsx(Playground$PropSpreadExample, {})
+ ]
+ });
+
+export {
+ AutomaticModeExample ,
+ ClassicModeExample ,
+ NoAttributeExample ,
+ ReactInterfaceExample ,
+ PropTypeInjectionExample ,
+ PropSpreadExample ,
+ root ,
+}
+```
+{text->React.string}
+}
+```
+
+Now let's dynamically import the `
+ {Preact.string("Hello " ++ name)}
+
+}
+```
+
+Read more in the [new documentation on the generic JSX transform](/docs/manual/latest/jsx#generic-jsx-transform-jsx-beyond-react-experimental).
+
+## Tagged template literals
+
+This release comes with support for [tagged templates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates).
+
+A tag function in JavaScript is a function that expects an array of strings and variadic parameters as input. Now it's possibe to bind to such functions with the new [`@taggedTemplate`](/syntax-lookup#taggedTemplate-decorator) decorator:
+
+
+
-
+
-
+
The error messages above are cryptic and hard to understand. And the limitation of not supporting recursive functions make uncurried support pretty weak.
Now those limitations are all gone, you can have polymorphic uncurried recursive functions and it support labels.
-
+
-
+
The error message is also enhanced significantly
diff --git a/_blogposts/archive/2020-05-11-state-of-reasonml-org-2020-q2-pt2.mdx b/_blogposts/archive/2020-05-11-state-of-reasonml-org-2020-q2-pt2.mdx
index abed7dcf0..1916a2a37 100644
--- a/_blogposts/archive/2020-05-11-state-of-reasonml-org-2020-q2-pt2.mdx
+++ b/_blogposts/archive/2020-05-11-state-of-reasonml-org-2020-q2-pt2.mdx
@@ -33,7 +33,7 @@ List.head([1, 2, 3]); /* This should actually be Belt.List */
Running the test with the broken example would produce:
```sh
-node scripts/test-examples.js "pages/apis/latest/belt/list.mdx"
+node scripts/test-examples.mjs "pages/apis/latest/belt/list.mdx"
Testing example in 'pages/apis/latest/belt/list.mdx' on line 23...
Testing example in 'pages/apis/latest/belt/list.mdx' on line 43...
@@ -54,7 +54,7 @@ Failed: 1
Success: 55
Tip: You can also run tests just for specific files / globs:
-`node scripts/test-examples.js "pages/belt_docs/array.mdx"`
+`node scripts/test-examples.mjs "pages/belt_docs/array.mdx"`
-----------
Error Preview:
diff --git a/_blogposts/archive/2020-07-01-bucklescript-8-1-new-syntax.mdx b/_blogposts/archive/2020-07-01-bucklescript-8-1-new-syntax.mdx
index 9e7ec7bf0..a5ab94f05 100644
--- a/_blogposts/archive/2020-07-01-bucklescript-8-1-new-syntax.mdx
+++ b/_blogposts/archive/2020-07-01-bucklescript-8-1-new-syntax.mdx
@@ -16,7 +16,7 @@ The release of BuckleScript 8.1 contains a new important addition: we've rewritt
The rewrite was done by a community member of ours, [Maxim](https://twitter.com/_binary_search). Maxim was a main contributor to the old Reason repo, and together we've reached the conclusion a while ago that the codebase needed a revamp. After wrestling with it for the longest time, we've settled on a low-key rewrite.
-Syntax discussions have always been churny, so we didn't want to prematurity announce something before it's ready for proper critiques. After testing this extensively; we now deem it solid enough for your consumption.
+Syntax discussions have always been churny, so we didn't want to prematurely announce something before it's ready for proper critiques. After testing this extensively, we now deem it solid enough for your consumption.
**Here's what you need to know:**
- The new syntax comes directly with your BuckleScript >=8.1 installation. You won't have to install anything else. It does not depend on the old `refmt`.
diff --git a/_blogposts/archive/2020-07-06-a-note-on-bucklescripts-future-commitments.mdx b/_blogposts/archive/2020-07-06-a-note-on-bucklescripts-future-commitments.mdx
index 3f300f8ac..c9d15fa0c 100644
--- a/_blogposts/archive/2020-07-06-a-note-on-bucklescripts-future-commitments.mdx
+++ b/_blogposts/archive/2020-07-06-a-note-on-bucklescripts-future-commitments.mdx
@@ -16,7 +16,7 @@ description: |
Our [new ReScript syntax announcement](/blog/bucklescript-8-1-new-syntax) generated lots of good feedback, but also raised some concerns from community members whose use-cases still align with our goal, but sometimes extend outside of it, and who are worried about further commitments to the ecosystem in the face of new unknowns.
-This post is dedicated to answer some commons questions regarding trust, breakages, and future investment.
+This post is dedicated to answer some common questions regarding trust, breakages, and future investment.
## Q & A
diff --git a/compilers/README.md b/compilers/README.md
index 37503ac3b..ceebd0b28 100644
--- a/compilers/README.md
+++ b/compilers/README.md
@@ -2,4 +2,4 @@
This folder is needed to install additional rescript compiler versions for testing our documented source code on multiple compiler versions.
-Our `scripts/test-examples.js` script will automatically install all package.json dependencies if it cannot find any compiler versions.
+Our `scripts/test-examples.mjs` script will automatically install all package.json dependencies if it cannot find any compiler versions.
diff --git a/compilers/dummy/Dummy.res b/compilers/dummy/Dummy.res
new file mode 100644
index 000000000..216d35a7a
--- /dev/null
+++ b/compilers/dummy/Dummy.res
@@ -0,0 +1 @@
+Console.log("I am a dummy file")
diff --git a/compilers/package-lock.json b/compilers/package-lock.json
index e7c6749ba..9a20b57aa 100644
--- a/compilers/package-lock.json
+++ b/compilers/package-lock.json
@@ -9,11 +9,148 @@
"version": "1.0.0",
"license": "MIT",
"dependencies": {
+ "@rescript/core": "^1.3.0",
+ "@rescript/react": "^0.12.0",
+ "rescript-1000": "npm:rescript@10.0.0",
+ "rescript-1010": "npm:rescript@10.1.0",
+ "rescript-1100": "npm:rescript@11.0.0",
+ "rescript-1110": "npm:rescript@11.1.0",
"rescript-820": "npm:bs-platform@8.2.0",
"rescript-902": "npm:bs-platform@9.0.2",
"rescript-912": "npm:rescript@9.1.2"
}
},
+ "node_modules/@rescript/core": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/@rescript/core/-/core-1.3.0.tgz",
+ "integrity": "sha512-wNZOZ63sYcaIYZCmTZeIPCeLa3HCGgPbIOR8zjyNkoBYUlxNV8Nb2ZyqlXR5Mb9ttvv8fTV56JbKhyVEZEYo8g==",
+ "peerDependencies": {
+ "rescript": "^11.1.0-rc.7"
+ }
+ },
+ "node_modules/@rescript/react": {
+ "version": "0.12.0",
+ "resolved": "https://registry.npmjs.org/@rescript/react/-/react-0.12.0.tgz",
+ "integrity": "sha512-EBLsf5rD7sJOjgfLLGwuLw/hONszc3UtYnIVgv7OdTyUNR41/m4deVm62PI0agvr3kWakXz4KchKRSd+19/bRA==",
+ "peerDependencies": {
+ "react": ">=18.0.0",
+ "react-dom": ">=18.0.0"
+ }
+ },
+ "node_modules/js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
+ "peer": true
+ },
+ "node_modules/loose-envify": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
+ "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
+ "peer": true,
+ "dependencies": {
+ "js-tokens": "^3.0.0 || ^4.0.0"
+ },
+ "bin": {
+ "loose-envify": "cli.js"
+ }
+ },
+ "node_modules/react": {
+ "version": "18.2.0",
+ "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz",
+ "integrity": "sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ==",
+ "peer": true,
+ "dependencies": {
+ "loose-envify": "^1.1.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/react-dom": {
+ "version": "18.2.0",
+ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.2.0.tgz",
+ "integrity": "sha512-6IMTriUmvsjHUjNtEDudZfuDQUoWXVxKHhlEGSk81n4YFS+r/Kl99wXiwlVXtPBtJenozv2P+hxDsw9eA7Xo6g==",
+ "peer": true,
+ "dependencies": {
+ "loose-envify": "^1.1.0",
+ "scheduler": "^0.23.0"
+ },
+ "peerDependencies": {
+ "react": "^18.2.0"
+ }
+ },
+ "node_modules/rescript": {
+ "version": "11.1.1",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-11.1.1.tgz",
+ "integrity": "sha512-FMELeoiR1n3LzBdBt+k7U4l0vsz5Xh0HBSHf+0NhyhzZkMRLkEKEDNrcqZc6RIux9bxmxoO+zEa9qFM01VOXAw==",
+ "hasInstallScript": true,
+ "peer": true,
+ "bin": {
+ "bsc": "bsc",
+ "bstracing": "lib/bstracing",
+ "rescript": "rescript"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/rescript-1000": {
+ "name": "rescript",
+ "version": "10.0.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-10.0.0.tgz",
+ "integrity": "sha512-LhNg/4+0j8NvoFeslgAeYLlzUwkq6kR6l6v8BnZ61VDTxopK2l96uT1lq5lv1aMxzMDynvE2qnX0zalre+6XxA==",
+ "hasInstallScript": true,
+ "bin": {
+ "bsc": "bsc",
+ "bsrefmt": "bsrefmt",
+ "bstracing": "lib/bstracing",
+ "rescript": "rescript"
+ }
+ },
+ "node_modules/rescript-1010": {
+ "name": "rescript",
+ "version": "10.1.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-10.1.0.tgz",
+ "integrity": "sha512-85KLtBECo+hYwObbifXk5xpxUCUFMWgCR1w7hDDGhhXIXqEpHQ2ds6o++YPxzXjLuU1/qA7Iovq2zUX4opejQw==",
+ "hasInstallScript": true,
+ "bin": {
+ "bsc": "bsc",
+ "bsrefmt": "bsrefmt",
+ "bstracing": "lib/bstracing",
+ "rescript": "rescript"
+ }
+ },
+ "node_modules/rescript-1100": {
+ "name": "rescript",
+ "version": "11.0.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-11.0.0.tgz",
+ "integrity": "sha512-uIUwDZZmDUb7ymGkBiiGioxMg8hXh1mze/2k/qhYQcZGgi7PrLHQIW9AksM7gb9WnpjCAvFsA8U2VgC0nA468w==",
+ "hasInstallScript": true,
+ "bin": {
+ "bsc": "bsc",
+ "bstracing": "lib/bstracing",
+ "rescript": "rescript"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/rescript-1110": {
+ "name": "rescript",
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-11.1.0.tgz",
+ "integrity": "sha512-9la2Dv+ACylQ77I8s4spPu1JnLZXbH5WgxcLHLLUBWgFFSiv0wXqgzWztrBIZqwFgVX5BYcwldUqUVcEzdCyHg==",
+ "hasInstallScript": true,
+ "bin": {
+ "bsc": "bsc",
+ "bstracing": "lib/bstracing",
+ "rescript": "rescript"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
"node_modules/rescript-820": {
"name": "bs-platform",
"version": "8.2.0",
@@ -38,9 +175,90 @@
"bstracing": "lib/bstracing",
"rescript": "rescript"
}
+ },
+ "node_modules/scheduler": {
+ "version": "0.23.0",
+ "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.0.tgz",
+ "integrity": "sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==",
+ "peer": true,
+ "dependencies": {
+ "loose-envify": "^1.1.0"
+ }
}
},
"dependencies": {
+ "@rescript/core": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/@rescript/core/-/core-1.3.0.tgz",
+ "integrity": "sha512-wNZOZ63sYcaIYZCmTZeIPCeLa3HCGgPbIOR8zjyNkoBYUlxNV8Nb2ZyqlXR5Mb9ttvv8fTV56JbKhyVEZEYo8g==",
+ "requires": {}
+ },
+ "@rescript/react": {
+ "version": "0.12.0",
+ "resolved": "https://registry.npmjs.org/@rescript/react/-/react-0.12.0.tgz",
+ "integrity": "sha512-EBLsf5rD7sJOjgfLLGwuLw/hONszc3UtYnIVgv7OdTyUNR41/m4deVm62PI0agvr3kWakXz4KchKRSd+19/bRA==",
+ "requires": {}
+ },
+ "js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
+ "peer": true
+ },
+ "loose-envify": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
+ "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
+ "peer": true,
+ "requires": {
+ "js-tokens": "^3.0.0 || ^4.0.0"
+ }
+ },
+ "react": {
+ "version": "18.2.0",
+ "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz",
+ "integrity": "sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ==",
+ "peer": true,
+ "requires": {
+ "loose-envify": "^1.1.0"
+ }
+ },
+ "react-dom": {
+ "version": "18.2.0",
+ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.2.0.tgz",
+ "integrity": "sha512-6IMTriUmvsjHUjNtEDudZfuDQUoWXVxKHhlEGSk81n4YFS+r/Kl99wXiwlVXtPBtJenozv2P+hxDsw9eA7Xo6g==",
+ "peer": true,
+ "requires": {
+ "loose-envify": "^1.1.0",
+ "scheduler": "^0.23.0"
+ }
+ },
+ "rescript": {
+ "version": "11.1.1",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-11.1.1.tgz",
+ "integrity": "sha512-FMELeoiR1n3LzBdBt+k7U4l0vsz5Xh0HBSHf+0NhyhzZkMRLkEKEDNrcqZc6RIux9bxmxoO+zEa9qFM01VOXAw==",
+ "peer": true
+ },
+ "rescript-1000": {
+ "version": "npm:rescript@10.0.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-10.0.0.tgz",
+ "integrity": "sha512-LhNg/4+0j8NvoFeslgAeYLlzUwkq6kR6l6v8BnZ61VDTxopK2l96uT1lq5lv1aMxzMDynvE2qnX0zalre+6XxA=="
+ },
+ "rescript-1010": {
+ "version": "npm:rescript@10.1.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-10.1.0.tgz",
+ "integrity": "sha512-85KLtBECo+hYwObbifXk5xpxUCUFMWgCR1w7hDDGhhXIXqEpHQ2ds6o++YPxzXjLuU1/qA7Iovq2zUX4opejQw=="
+ },
+ "rescript-1100": {
+ "version": "npm:rescript@11.0.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-11.0.0.tgz",
+ "integrity": "sha512-uIUwDZZmDUb7ymGkBiiGioxMg8hXh1mze/2k/qhYQcZGgi7PrLHQIW9AksM7gb9WnpjCAvFsA8U2VgC0nA468w=="
+ },
+ "rescript-1110": {
+ "version": "npm:rescript@11.1.0",
+ "resolved": "https://registry.npmjs.org/rescript/-/rescript-11.1.0.tgz",
+ "integrity": "sha512-9la2Dv+ACylQ77I8s4spPu1JnLZXbH5WgxcLHLLUBWgFFSiv0wXqgzWztrBIZqwFgVX5BYcwldUqUVcEzdCyHg=="
+ },
"rescript-820": {
"version": "npm:bs-platform@8.2.0",
"resolved": "https://registry.npmjs.org/bs-platform/-/bs-platform-8.2.0.tgz",
@@ -55,6 +273,15 @@
"version": "npm:rescript@9.1.2",
"resolved": "https://registry.npmjs.org/rescript/-/rescript-9.1.2.tgz",
"integrity": "sha512-4wHvTDv3nyYnAPJHcg1RGG8z7u3HDiBf6RN3P/dITDv859Qo35aKOzJWQtfBzbAs0EKNafLqei3TnUqiAv6BwQ=="
+ },
+ "scheduler": {
+ "version": "0.23.0",
+ "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.0.tgz",
+ "integrity": "sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==",
+ "peer": true,
+ "requires": {
+ "loose-envify": "^1.1.0"
+ }
}
}
}
diff --git a/compilers/package.json b/compilers/package.json
index 44e912546..f03ee4390 100644
--- a/compilers/package.json
+++ b/compilers/package.json
@@ -5,6 +5,12 @@
"main": "index.js",
"license": "MIT",
"dependencies": {
+ "@rescript/core": "^1.3.0",
+ "@rescript/react": "^0.12.0",
+ "rescript-1000": "npm:rescript@10.0.0",
+ "rescript-1010": "npm:rescript@10.1.0",
+ "rescript-1100": "npm:rescript@11.0.0",
+ "rescript-1110": "npm:rescript@11.1.0",
"rescript-820": "npm:bs-platform@8.2.0",
"rescript-902": "npm:bs-platform@9.0.2",
"rescript-912": "npm:rescript@9.1.2"
diff --git a/compilers/rescript.json b/compilers/rescript.json
new file mode 100644
index 000000000..2b29c743a
--- /dev/null
+++ b/compilers/rescript.json
@@ -0,0 +1,15 @@
+{
+ "name": "dummy",
+ "jsx": { "version": 4 },
+ "sources": {
+ "dir": "dummy",
+ "subdirs": true
+ },
+ "bs-dependencies": [
+ "@rescript/core",
+ "@rescript/react"
+ ],
+ "bsc-flags": [
+ "-open RescriptCore"
+ ]
+}
\ No newline at end of file
diff --git a/data/api/v11.0.0/belt.json b/data/api/v11.0.0/belt.json
new file mode 100644
index 000000000..86bc0c43e
--- /dev/null
+++ b/data/api/v11.0.0/belt.json
@@ -0,0 +1,9318 @@
+{
+ "belt": {
+ "id": "Belt",
+ "name": "Belt",
+ "docstrings": [
+ "The ReScript standard library.\n\nBelt is currently mostly covering collection types. It has no string or date functions yet, although Belt.String is in the works. In the meantime, use [Js.String](js/string) for string functions and [Js.Date](js/date) for date functions.\n\n## Motivation\n\nBelt provides:\n\n- The **highest quality** immutable data structures in JavaScript.\n- Safety by default: A Belt function will never throw exceptions, unless it is\n indicated explicitly in the function name (suffix \"Exn\").\n- Better performance and smaller code size running on the JS platform.\n- Ready for [Tree Shaking](https://webpack.js.org/guides/tree-shaking/).\n\n## Usage\n\nTo use modules from Belt, either refer to them by their fully qualified name (`Belt.List`, `Belt.Array` etc.) or open the `Belt` module by putting\n\n## Examples\n\n```rescript\nopen Belt\n```\n\nat the top of your source files. After opening Belt this way, `Array` will refer to `Belt.Array`, `List` will refer to `Belt.List` etc. in the subsequent code.\n\nIf you want to open Belt globally for all files in your project instead, you can put\n\n```json\n{\n \"bsc-flags\": [\"-open Belt\"]\n}\n```\n\ninto your `bsconfig.json`.\n\n**Note**: this is the **only** `open` we encourage.\n\nExample usage:\n\n## Examples\n\n```rescript\nlet someNumbers = [1, 1, 4, 2, 3, 6, 3, 4, 2]\n\nlet greaterThan2UniqueAndSorted =\n someNumbers\n ->Belt.Array.keep(x => x > 2)\n // convert to and from set to make values unique\n ->Belt.Set.Int.fromArray\n ->Belt.Set.Int.toArray // output is already sorted\n\nJs.log2(\"result\", greaterThan2UniqueAndSorted)\n```\n\n## Curried vs. Uncurried Callbacks\n\nFor functions taking a callback parameter, there are usually two versions\navailable:\n\n- curried (no suffix)\n- uncurried (suffixed with `U`)\n\nE.g.:\n\n## Examples\n\n```rescript\nlet forEach: (t<'a>, 'a => unit) => unit\n\nlet forEachU: (t<'a>, (. 'a) => unit) => unit\n```\n\nThe uncurried version will be faster in some cases, but for simplicity we recommend to stick with the curried version unless you need the extra performance.\n\nThe two versions can be invoked as follows:\n\n## Examples\n\n```rescript\n[\"a\", \"b\", \"c\"]->Belt.Array.forEach(x => Js.log(x))\n\n[\"a\", \"b\", \"c\"]->Belt.Array.forEachU((. x) => Js.log(x))\n```\n\n## Specialized Collections\n\nFor collections types like set or map, Belt provides both a generic module as well as specialized, more efficient implementations for string and int keys.\n\nFor example, Belt has the following set modules:\n\n- [Belt.Set](belt/set)\n- [Belt.Set.Int](belt/set/int)\n- [Belt.Set.String](belt/set/string)\n\n## Implementation Details\n\n### Array access runtime safety\n\nOne common confusion comes from the way Belt handles array access. It differs from than the default standard library's.\n\n## Examples\n\n```rescript\nlet letters = [\"a\", \"b\", \"c\"]\nlet a = letters[0] // a == \"a\"\nlet capitalA = Js.String.toUpperCase(a)\nlet k = letters[10] // Raises an exception! The 10th index doesn't exist.\n```\n\nBecause Belt avoids exceptions and returns `options` instead, this code behaves differently:\n\n## Examples\n\n```rescript\nopen Belt\nlet letters = [\"a\", \"b\", \"c\"]\nlet a = letters[0] // a == Some(\"a\")\nlet captialA = Js.String.toUpperCase(a) // Type error! This code will not compile.\nlet k = letters[10] // k == None\n```\n\nAlthough we've fixed the problem where `k` raises an exception, we now have a type error when trying to capitalize `a`. There are a few things going on here:\n\n- Reason transforms array index access to the function `Array.get`. So `letters[0]` is the same as `Array.get(letters, 0)`.\n- The compiler uses whichever `Array` module is in scope. If you `open Belt`, then it uses `Belt.Array`.\n- `Belt.Array.get` returns values wrapped in options, so `letters[0] == Some(\"a\")`.\n\nFortunately, this is easy to fix:\n\n## Examples\n\n```rescript\nopen Belt\nlet letters = [\"a\", \"b\", \"c\"]\nlet a = letters[0]\n\n// Use a switch statement:\nlet capitalA =\n switch a {\n | Some(a) => Some(Js.String.toUpperCase(a))\n | None => None\n }\n\nlet k = letters[10] // k == None\n```\n\nWith that little bit of tweaking, our code now compiles successfully and is 100% free of runtime errors!\n\n### A Special Encoding for Collection Safety\n\nWhen we create a collection library for a custom data type we need a way to provide a comparator function. Take Set for example, suppose its element type is a pair of ints, it needs a custom compare function that takes two tuples and returns their order. The Set could not just be typed as Set.t (int \\* int) , its customized compare function needs to manifest itself in the signature, otherwise, if the user creates another customized compare function, the two collection could mix which would result in runtime error.\n\nWe use a phantom type to solve the problem:\n\n## Examples\n\n```rescript\nmodule Comparable1 =\n Belt.Id.MakeComparable(\n {\n type t = (int, int)\n let cmp = ((a0, a1), (b0, b1)) =>\n switch Pervasives.compare(a0, b0) {\n | 0 => Pervasives.compare(a1, b1)\n | c => c\n }\n }\n )\n\nlet mySet1 = Belt.Set.make(~id=module(Comparable1))\n\nmodule Comparable2 =\n Belt.Id.MakeComparable(\n {\n type t = (int, int)\n let cmp = ((a0, a1), (b0, b1)) =>\n switch Pervasives.compare(a0, b0) {\n | 0 => Pervasives.compare(a1, b1)\n | c => c\n }\n }\n )\n\nlet mySet2 = Belt.Set.make(~id=module(Comparable2))\n```\n\nHere, the compiler would infer `mySet1` and `mySet2` having different type, so e.g. a `merge` operation that tries to merge these two sets will correctly fail.\n\n## Examples\n\n```rescript\nlet mySet1: t<(int, int), Comparable1.identity>\nlet mySet2: t<(int, int), Comparable2.identity>\n```\n\n`Comparable1.identity` and `Comparable2.identity` are not the same using our encoding scheme."
+ ],
+ "items": []
+ },
+ "belt/hashmap/string": {
+ "id": "Belt.HashMap.String",
+ "name": "String",
+ "docstrings": [
+ "Specalized when key type is `string`, more efficient than the generic type"
+ ],
+ "items": [
+ {
+ "id": "Belt.HashMap.String.key",
+ "kind": "type",
+ "name": "key",
+ "docstrings": [],
+ "signature": "type key = string"
+ },
+ {
+ "id": "Belt.HashMap.String.t",
+ "kind": "type",
+ "name": "t",
+ "docstrings": [],
+ "signature": "type t<'b>"
+ },
+ {
+ "id": "Belt.HashMap.String.make",
+ "kind": "value",
+ "name": "make",
+ "docstrings": [],
+ "signature": "let make: (~hintSize: int) => t<'b>"
+ },
+ {
+ "id": "Belt.HashMap.String.clear",
+ "kind": "value",
+ "name": "clear",
+ "docstrings": [],
+ "signature": "let clear: t<'b> => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.isEmpty",
+ "kind": "value",
+ "name": "isEmpty",
+ "docstrings": [],
+ "signature": "let isEmpty: t<'a> => bool"
+ },
+ {
+ "id": "Belt.HashMap.String.set",
+ "kind": "value",
+ "name": "set",
+ "docstrings": [
+ "`setDone(tbl, k, v)` if `k` does not exist, add the binding `k,v`, otherwise,\nupdate the old value with the new `v`"
+ ],
+ "signature": "let set: (t<'a>, key, 'a) => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.copy",
+ "kind": "value",
+ "name": "copy",
+ "docstrings": [],
+ "signature": "let copy: t<'a> => t<'a>"
+ },
+ {
+ "id": "Belt.HashMap.String.get",
+ "kind": "value",
+ "name": "get",
+ "docstrings": [],
+ "signature": "let get: (t<'a>, key) => option<'a>"
+ },
+ {
+ "id": "Belt.HashMap.String.has",
+ "kind": "value",
+ "name": "has",
+ "docstrings": [],
+ "signature": "let has: (t<'b>, key) => bool"
+ },
+ {
+ "id": "Belt.HashMap.String.remove",
+ "kind": "value",
+ "name": "remove",
+ "docstrings": [],
+ "signature": "let remove: (t<'a>, key) => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.forEachU",
+ "kind": "value",
+ "name": "forEachU",
+ "docstrings": [],
+ "signature": "let forEachU: (t<'b>, (key, 'b) => unit) => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.forEach",
+ "kind": "value",
+ "name": "forEach",
+ "docstrings": [],
+ "signature": "let forEach: (t<'b>, (key, 'b) => unit) => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.reduceU",
+ "kind": "value",
+ "name": "reduceU",
+ "docstrings": [],
+ "signature": "let reduceU: (t<'b>, 'c, ('c, key, 'b) => 'c) => 'c"
+ },
+ {
+ "id": "Belt.HashMap.String.reduce",
+ "kind": "value",
+ "name": "reduce",
+ "docstrings": [],
+ "signature": "let reduce: (t<'b>, 'c, ('c, key, 'b) => 'c) => 'c"
+ },
+ {
+ "id": "Belt.HashMap.String.keepMapInPlaceU",
+ "kind": "value",
+ "name": "keepMapInPlaceU",
+ "docstrings": [],
+ "signature": "let keepMapInPlaceU: (t<'a>, (key, 'a) => option<'a>) => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.keepMapInPlace",
+ "kind": "value",
+ "name": "keepMapInPlace",
+ "docstrings": [],
+ "signature": "let keepMapInPlace: (t<'a>, (key, 'a) => option<'a>) => unit"
+ },
+ {
+ "id": "Belt.HashMap.String.size",
+ "kind": "value",
+ "name": "size",
+ "docstrings": [],
+ "signature": "let size: t<'a> => int"
+ },
+ {
+ "id": "Belt.HashMap.String.toArray",
+ "kind": "value",
+ "name": "toArray",
+ "docstrings": [],
+ "signature": "let toArray: t<'a> => array<(key, 'a)>"
+ },
+ {
+ "id": "Belt.HashMap.String.keysToArray",
+ "kind": "value",
+ "name": "keysToArray",
+ "docstrings": [],
+ "signature": "let keysToArray: t<'a> => array\nThe function `f` must have a return type of `option<'b>`.\n\n## Examples\n\n```rescript\nlet addIfAboveOne = value =>\n if (value > 1) {\n Some(value + 1)\n } else {\n None\n }\n\nBelt.Option.flatMap(Some(2), addIfAboveOne) /* Some(3) */\n\nBelt.Option.flatMap(Some(-4), addIfAboveOne) /* None */\n\nBelt.Option.flatMap(None, addIfAboveOne) /* None */\n```" + ], + "signature": "let flatMap: (option<'a>, 'a => option<'b>) => option<'b>" + }, + { + "id": "Belt.Option.getWithDefault", + "kind": "value", + "name": "getWithDefault", + "docstrings": [ + "If `optionalValue` is `Some(value)`, returns `value`, otherwise default.\n\n## Examples\n\n```rescript\nBelt.Option.getWithDefault(None, \"Banana\") /* Banana */\n\nBelt.Option.getWithDefault(Some(\"Apple\"), \"Banana\") /* Apple */\n```\n\n```rescript\nlet greet = (firstName: option