Version 0.3.0

Author: clo4

README.md

@@ -1,6 +1,6 @@
 # deno_mock_fetch
 
-An _extremely_ simple way to mock `window.fetch`.
+An _extremely_ simple way to mock `globalThis.fetch`.
 
 [Read the documentation][docs], or see "Usage" below.
 
@@ -14,9 +14,9 @@ Import the library and install the mock. Any fetches after calling `install()`
 will throw an error if you haven't explicitly added a mock for that route.
 
 ```typescript
-import * as mf from "https://deno.land/x/mock_fetch@0.2.0/mod.ts";
+import * as mf from "https://deno.land/x/mock_fetch@0.3.0/mod.ts";
 
-// Replaces window.fetch with the mocked copy
+// Replaces globalThis.fetch with the mocked copy
 mf.install();
 ```
 
@@ -28,16 +28,16 @@ Call `mock` with a route (optionally starting with a method specifier, eg.
 `DELETE@`) and a function (can be async). Whenever that route is fetched, the
 function will be executed and the response will be returned.
 
-The route uses [path-to-regexp], which allows you to use wildcard parameters.
+The route uses [URLPattern], which allows you to match patterns and wildcards.
 
 **Only the path name will be used to match a handler**, so you can use literally
 anything for the host when fetching.
 
-[path-to-regexp]: https://github.com/pillarjs/path-to-regexp#parameters
+[URLPattern]: https://github.com/WICG/urlpattern/blob/main/explainer.md#web-apis
 
 ```typescript
-mf.mock("GET@/api/hello/:name", (_req, match) => {
-  return new Response(`Hello, ${match.params["name"]}!`, {
+mf.mock("GET@/api/hello/:name", (_req, params) => {
+  return new Response(`Hello, ${params["name"]}!`, {
     status: 200,
   });
 });
@@ -55,7 +55,8 @@ with `reset`. Once the handler has been removed, that route will go back to
 throwing.
 
 ```typescript
-mf.remove("GET@/api/hello/:name"); // OR: mf.reset()
+mf.remove("GET@/api/hello/:name");
+// OR: mf.reset()
 
 await fetch("https://example.com/api/hello/world");
 // UnhandledRouteError: GET /api/hello/world (0 routes have handlers)
@@ -102,12 +103,16 @@ myKy.put("blog/posts", {
 
 You can destructure it, too.
 
+```typescript
+const { fetch, mock, remove, reset} = mf.sandbox();
+```
+
 <br>
 
 ## Credits
 
 **[@eliassjogreen]**'s tiny router ([source][router]) does the bulk of the work.
-It's general purpose, but works great for Deno Deploy.
+It's general-purpose, but works great for Deno Deploy.
 
 [@eliassjogreen]: https://github.com/eliassjogreen
-[router]: https://crux.land/router@0.0.4
+[router]: https://crux.land/router@0.0.5

mod.ts

@@ -1,4 +1,6 @@
-import { MatchHandler, router, Routes } from "https://crux.land/router@0.0.4";
+import { MatchHandler, router, Routes } from "https://crux.land/router@0.0.5";
+
+export type { MatchHandler };
 
 class UnhandledRouteError extends Error {
   routes: Routes;
@@ -9,10 +11,12 @@ class UnhandledRouteError extends Error {
     const method = request.method;
     const reqPath = new URL(request.url).pathname;
     const routesNumber = Object.entries(routes).length;
-    const routePlural = routesNumber === 1 ? "route" : "routes";
+    const routePlural = routesNumber === 1
+      ? "route has a handler"
+      : "routes have handlers";
 
     // deno-fmt-ignore
-    super(`${method} ${reqPath} (${routesNumber} ${routePlural} have handlers)`);
+    super(`${method} ${reqPath} (${routesNumber} ${routePlural})`);
 
     this.name = this.constructor.name;
     if (Error.captureStackTrace) {
@@ -24,25 +28,24 @@ class UnhandledRouteError extends Error {
   }
 }
 
-type MockFetch = {
+export interface MockFetch {
   fetch: typeof globalThis.fetch;
   mock: (route: string, handler: MatchHandler) => void;
   remove: (route: string) => void;
   reset: () => void;
-};
+}
 
 /**
-  * Create a stateful version of the global functions that do not contain
-  * any global state.
-  *
-  * The returned object can be destructured.
-  *
-  * ```
-  * const { fetch, mock, remove, reset } = sandbox()
-  * ```
-  */
+ * Get a set of functions that do not share any state with the globals.
+ *
+ * The returned object can be destructured.
+ *
+ * ```
+ * const { fetch, mock, remove, reset } = sandbox()
+ * ```
+ */
 export function sandbox(): MockFetch {
-  const routeStore: Map<string, MatchHandler> = new Map();
+  const routeStore = new Map<string, MatchHandler>();
 
   async function fetch(
     input: string | Request | URL,
@@ -99,14 +102,15 @@ export const mockedFetch = globalMockFetch.fetch;
 /**
  * Mock a new route, or override an existing handler.
  *
- * The route uses path-to-regexp syntax, with the additional extension of
- * (optional) method routing (prefix with METHOD@, eg. `POST@/user/:id`).
+ * The route uses URLPattern syntax, with the additional extension of
+ * (optional) method routing by prefixing with the method,
+ * eg. `"POST@/user/:id"`.
  *
- * The handler function can either be a function or an async function.
+ * The handler function may be asynchronous.
  *
  * ```
- * mock("GET@/users/:id", async (_req, match) => {
- *   const id = parseInt(match.params["id"]);
+ * mock("GET@/users/:id", async (_req, params) => {
+ *   const id = parseInt(params["id"]);
  *   const data = await magicallyGetMyUserData(id);
  *   return new Response(JSON.stringify(data));
  * })
@@ -123,17 +127,20 @@ export const reset = globalMockFetch.reset;
 // Store the original fetch so it can be restored later
 const originalFetch = globalThis.fetch;
 
+// The functions below are `const` for consistency.
+
 /**
- * Replace `window.fetch` with a mock that routes requests to a matching handler.
+ * Replace `globalThis.fetch` with `mockedFetch` (or another function that
+ * matches the `fetch` signature)
  *
- * To reset `window.fetch`, call `uninstall()`.
+ * To restore the original `globalThis.fetch`, call `uninstall()`.
  */
-export const install = () => {
-  globalThis.fetch = mockedFetch;
+export const install = (replacement?: typeof fetch) => {
+  globalThis.fetch = replacement ?? mockedFetch;
 };
 
 /**
- * Restore `window.fetch` to what it was before `install()` was called.
+ * Restore `globalThis.fetch` to what it was before this library was imported.
  */
 export const uninstall = () => {
   globalThis.fetch = originalFetch;

test.ts

@@ -2,7 +2,7 @@ import {
   assertEquals,
   assertNotEquals,
   assertThrowsAsync,
-} from "https://deno.land/std@0.101.0/testing/asserts.ts";
+} from "https://deno.land/std@0.113.0/testing/asserts.ts";
 import * as mf from "./mod.ts";
 
 Deno.test({
@@ -81,7 +81,7 @@ Deno.test({
     mf.install();
 
     mf.mock("DELETE@/lights/:id", (_req, match) => {
-      assertEquals(match.params["id"], "2");
+      assertEquals(match["id"], "2");
       return new Response();
     });