Merge pull request #738 from wheresrhys/rhys/types3

Rhys/types3

.gitignore

@@ -1,4 +1,4 @@
-/node_modules/
+node_modules/
 
 # tooling artefacts
 /docs/.sass-cache/

.husky/pre-commit

@@ -1 +1 @@
-npm run lint
+npm run lint && npm run types:lint && npm run types:check

docs/blog/2024-07-21-introducing-core.md

@@ -53,6 +53,14 @@ fetchMock.mock('http://my.site', 200);
 
 which keeps fetch-mock's methods much further away from any other library's workings.
 
+## .getAny(), .postAny(), .putAny(), .deleteAny(), .headAny(), .patchAny(), .getAnyOnce(), .postAnyOnce(), .putAnyOnce(), .deleteAnyOnce(), .headAnyOnce(), .patchAnyOnce()
+
+While `.getOnce()` etc feel very useful, the `any` and `anyOnce` variants added a lot of repetition to the code and types, and don't actually add much value.
+
+`.___AnyOnce(response, options)`
+
+Creates a route that responds to any single request using a particular http method.
+
 ### Gone, but back soon
 
 The following features will return in other libraries that wrap @fetch-mock/core for different environments.

docs/docs/@fetch-mock/core/more-routing-methods.md

@@ -61,18 +61,6 @@ fetchMock.purge = function (matcher, response, options) {
 
 Creates a route that only responds to a single request using a particular http method
 
-## .getAny(), .postAny(), .putAny(), .deleteAny(), .headAny(), .patchAny()
-
-`.___Any(response, options)`
-
-Creates a route that responds to any requests using a particular http method.
-
-## .getAnyOnce(), .postAnyOnce(), .putAnyOnce(), .deleteAnyOnce(), .headAnyOnce(), .patchAnyOnce()
-
-`.___AnyOnce(response, options)`
-
-Creates a route that responds to any single request using a particular http method.
-
 ## .addMatcher(options)
 
 Allows adding your own, reusable custom matchers to fetch-mock, for example a matcher for interacting with GraphQL queries, or an `isAuthorized` matcher that encapsulates the exact authorization conditions for the API you are mocking, and only requires a `true` or `false` to be input

jsconfig.json

@@ -5,22 +5,32 @@
             "dom",
             "dom.iterable"
         ],
+        "moduleResolution": "nodenext",
+        "module": "NodeNext",
         "allowJs": true,
         "checkJs": true,
         "strict": true,
         "noImplicitAny": true,
         "noImplicitThis": true,
         "strictNullChecks": false,
         "strictFunctionTypes": true,
-        "types": [        ],
-        "noEmit": true,
+        "types": [
+        ],
         "downlevelIteration": true,
-        "forceConsistentCasingInFileNames": true
+        "forceConsistentCasingInFileNames": true,
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "outDir": "packages/core/types",
+        "skipLibCheck": true,
+        "noEmit": false,
+        "target": "es2021",
+        "removeComments": true
     },
     "include": [
-        "packages/core/src/*.js",
+        "./packages/core/src/*.js"
     ],
     "exclude": [
-        "node_modules"
+        "node_modules",
+        "packages/**/src/__tests__"
     ]
-}
+}

package.json

@@ -59,9 +59,11 @@
     "prettier": "^3.1.1",
     "rollup": "^4.9.1",
     "ts-to-jsdoc": "^2.1.0",
-    "typescript": "^3.9.10",
+    "typescript": "^5.5.3",
     "v8": "^0.1.0",
     "vitest": "^1.1.0",
+    "@types/events": "^3.0.3",
+    "@types/globrex": "^0.1.4",
     "webdriverio": "^8.27.0"
   },
   "volta": {

packages/core/package.json

@@ -4,6 +4,7 @@
   "exports": "src/index.js",
   "version": "0.3.1",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

packages/core/src/CallHistory.js

@@ -65,6 +65,9 @@ class CallHistory {
 		this.callLogs.push(callLog);
 	}
 
+	/**
+	 * @returns {void}
+	 */
 	clear() {
 		this.callLogs.forEach(({ route }) => route.reset());
 		this.callLogs = [];