docs: document how to run tests for the type definitions

josdejong · May 16, 2024 · 49df889 · 49df889
1 parent 599f4ee
commit 49df889
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -160,6 +160,10 @@ Then, the tests can be executed:
 
     npm test
 
+To test the type definitions:
+
+    npm run test:types
+
 Additionally, the tests can be run on FireFox using [headless mode](https://developer.mozilla.org/en-US/Firefox/Headless_mode):
 
     npm run test:browser

diff --git a/types/EXPLANATION.md b/types/EXPLANATION.md
@@ -1,6 +1,6 @@
 # Mathjs TypeScript types
 
-The code base of Mathjs is writting in JavaScript. The TypeScript definitions are maintained separately. 
+The code base of Mathjs is written in JavaScript. The TypeScript definitions are maintained separately. 
 
 ## Library structure
 
@@ -52,3 +52,15 @@ export const {
   // ...
 } : Record<string, FactoryFunctionMap>
 ```
+
+## Testing the type definitions
+
+The types are defined in `types/index.d.ts`.
+
+The tests for the type definitions are located in `test/typescript-types/testTypes.ts`.
+
+To run the tests for the type definitions:
+
+```
+npm run test:types
+```