typecheck

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Unit tests
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
       - run: yarn
       - run: yarn test
       - name: cypress
@@ -38,17 +38,27 @@ jobs:
       - name: Lints
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
       - run: yarn
       - run: yarn lint
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Type Check
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x.x
+      - run: yarn
+      - run: yarn typecheck
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - name: Lints
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
       - run: yarn
       - run: yarn build
 

cypress.config.js

@@ -1,3 +1,4 @@
+// @ts-check
 import fetch from 'node-fetch';
 import { defineConfig } from 'cypress';
 import webpackConfig from './webpack.config.js';

jambox.config.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  * This config is used for integration tests
  *

package.json

@@ -21,6 +21,7 @@
     "build": "webpack",
     "dev": "nodemon --watch ext --watch src --exec ./jam-server.mjs",
     "test": "c8 -r=text -r=lcov ava",
+    "typecheck": "tsc",
     "e2e": "c8 -o ./coverage-cypress -r=text -r=lcov node ./e2e-backend.mjs",
     "e2e-dev": "nodemon --watch ext --watch src --exec ./e2e-backend.mjs",
     "cy": "HTTP_PROXY=http://localhost:8000 cypress open --component",

src/Config.mjs

@@ -33,17 +33,23 @@ export default class Config extends Emitter {
   logLocation = '';
   errors = [];
   /**
-   * @member {ProxyConfig}
+   * @type {import('./index.js').ProxyInfo}
    */
   proxy;
   noProxy = ['<-loopback->'];
   trust = new Set();
+  /**
+   * @type {Record<string, import('./index.js').ForwardOption>}
+   */
   forward = null;
   /**
-   * @member {object|null}
+   * @type {import('./index.js').CacheOption}
    */
   cache;
-  stub = null;
+  /**
+   * @type {Record<string, import('./index.js').StubOption>}
+   */
+  stub;
   blockNetworkRequests = false;
   paused = false;
   /**

src/Jambox.mjs

@@ -188,7 +188,7 @@ export default class Jambox extends Emitter {
   }
 
   /**
-   * @param {import('./index.js').StubOption} stubs
+   * @param {Record<string, import('./index.js').StubOption>} stubs
    */
   stub(stubs) {
     return Promise.all(

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["src/**/*", "cypress.config.js", "jambox.config.js"],
+  "include": ["src/**/*"],
   "exclude": ["src/**/__tests__/*", "src/**/__mocks__/*"],
   "compilerOptions": {
     "target": "ES2022",
@@ -12,7 +12,8 @@
     "outDir": "dist",
     "declarationMap": true,
     "moduleResolution": "NodeNext",
-    "sourceMap": false
+    "sourceMap": false,
+    "skipLibCheck": true
   },
   "typeAcquisition": {
     "enable": true,