Skip to content

Commit b6560da

Browse files
committed
Add some more context in shim config
1 parent 06c4c4f commit b6560da

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

pages/docs/gentype/latest/getting-started.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ structure:
8383

8484
## Adding Shims (TS & Flow)
8585

86-
Configure your shim files in your `"gentypeconfig"` in [`bsconfig.json`](https://github.com/reason-association/genType/blob/master/examples/typescript-react-example/bsconfig.json), and add relevant `.shims.js` files in a directory which is visible by ReScript e.g. [`src/shims/`](https://github.com/reason-association/genType/blob/master/examples/typescript-react-example/src/shims). An example shim to export ReactEvent can be found [here](https://github.com/reason-association/genType/blob/master/examples/typescript-react-example/src/shims/ReactEvent.shim.ts).
86+
A shim is a TS / Flow file that provides user-defined definitions for library types.
87+
88+
Configure your shim files within `"gentypeconfig"` in your [`bsconfig.json`](https://github.com/reason-association/genType/blob/master/examples/typescript-react-example/bsconfig.json), and add relevant `.shims.js` files in a directory which is visible by ReScript e.g. [`src/shims/`](https://github.com/reason-association/genType/blob/master/examples/typescript-react-example/src/shims). An example shim to export ReactEvent can be found [here](https://github.com/reason-association/genType/blob/master/examples/typescript-react-example/src/shims/ReactEvent.shim.ts).
8789

8890
## Testing the Whole Setup
8991

0 commit comments

Comments
 (0)