feat(commons): Add expectStatus jest testing helper

mittwald · Mar 8, 2024 · f6a3e63 · f6a3e63
1 parent 48692f2
commit f6a3e63
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 0 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/packages/commons/package.json b/packages/commons/package.json
@@ -20,6 +20,10 @@
       "types": "./dist/types/index.d.ts",
       "default": "./dist/esm/index.js"
     },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "default": "./dist/testing/index.js"
+    },
     "./react": {
       "types": "./dist/types/react/index.d.ts",
       "default": "./dist/esm/react/index.js"
@@ -67,6 +71,9 @@
     "@mittwald/react-use-promise": "^2.1.0"
   },
   "peerDependenciesMeta": {
+    "@jest/globals": {
+      "optional": true
+    },
     "@mittwald/react-use-promise": {
       "optional": true
     }

diff --git a/packages/commons/src/testing/expectStatus.ts b/packages/commons/src/testing/expectStatus.ts
@@ -0,0 +1,13 @@
+import { expect } from "@jest/globals";
+import assertStatus from "../types/assertStatus.js";
+import { Response } from "../types/Response.js";
+
+export function expectStatus<T extends Response, S extends T["status"]>(
+  response: T,
+  status: S,
+): asserts response is T & { status: S } {
+  expect(response.status).toBe(status);
+  assertStatus(response, status);
+}
+
+export default expectStatus;
diff --git a/packages/commons/src/testing/index.ts b/packages/commons/src/testing/index.ts
@@ -0,0 +1 @@
+export * from "./expectStatus.js";
diff --git a/yarn.lock b/yarn.lock
@@ -1154,6 +1154,8 @@ __metadata:
   peerDependencies:
     "@mittwald/react-use-promise": ^2.1.0
   peerDependenciesMeta:
+    "@jest/globals":
+      optional: true
     "@mittwald/react-use-promise":
       optional: true
   languageName: unknown