Skip to content

Commit e56484d

Browse files
committed
typesafety docs
1 parent 1e7e2a6 commit e56484d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ You can use the same command to add monorepo packages to one another (similar to
134134
lerna add @modus/eslint-config-modus --scope @modus/more
135135
```
136136

137+
### Type safety
138+
139+
This project uses JSDoc annotations to provide type information in JS files via TypeScript. This works extremely well with VS Code, adds Intellisense, and doesn't require a build step.
140+
141+
See the [official docs](https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript) for more information.
142+
137143
### Publishing
138144

139145
The project is currently published to Modus internal npm repo [https://npm.modus.app](https://npm.modus.app). This will change once we have a stable project.

0 commit comments

Comments
 (0)