Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clo4/deno_mock_fetch
Use URLPattern syntax to mock fetch responses
https://github.com/clo4/deno_mock_fetch
deno fetch-mock mock-fetch typescript
Last synced: 3 months ago
JSON representation
Use URLPattern syntax to mock fetch responses
- Host: GitHub
- URL: https://github.com/clo4/deno_mock_fetch
- Owner: clo4
- License: mit
- Created: 2021-07-17T10:51:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-07T09:17:19.000Z (over 3 years ago)
- Last Synced: 2024-10-28T12:16:15.099Z (3 months ago)
- Topics: deno, fetch-mock, mock-fetch, typescript
- Language: TypeScript
- Homepage: https://doc.deno.land/https/deno.land/x/mock_fetch/mod.ts
- Size: 10.7 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# deno_mock_fetch
An _extremely_ simple way to mock `globalThis.fetch`.
[Read the documentation][docs], or see "Usage" below.
[docs]: https://doc.deno.land/https/deno.land/x/mock_fetch/mod.ts
## Usage
### 1. Setup
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/[email protected]/mod.ts";
// Replaces globalThis.fetch with the mocked copy
mf.install();
```
### 2. Mocking routes
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 [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.
[URLPattern]: https://github.com/WICG/urlpattern/blob/main/explainer.md#web-apis
```typescript
mf.mock("GET@/api/hello/:name", (_req, params) => {
return new Response(`Hello, ${params["name"]}!`, {
status: 200,
});
});
const res = await fetch("https://localhost:1234/api/hello/SeparateRecords");
const text = await res.text(); //=> "Hello, SeparateRecords!"
```
### 3. Teardown
You can remove a single route's handler with `remove`, or reset all handlers
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()
await fetch("https://example.com/api/hello/world");
// UnhandledRouteError: GET /api/hello/world (0 routes have handlers)
```
To restore the original `fetch`, call `uninstall`.
```typescript
mf.uninstall();
```
## Advanced usage
You don't have to replace the global fetch, or even have global state, by using
the `sandbox` function. The returned object provides the same methods as the
module (minus install & uninstall). Calling these methods will not alter global
state.
```typescript
// Ky is an excellent and easy-to-use fetch wrapper.
import ky from "https://cdn.skypack.dev/ky?dts";
// This object can also be destructured.
const mockFetch = mf.sandbox();
// Make a ky instance that uses mocked fetch - never touching the global fetch.
// Using a prefix URL means you won't need to write the URL every time.
const myKy = ky.extend({
fetch: mockFetch.fetch,
prefixUrl: "https://anyurlyouwant.com",
});
// Now you can mock the routes like normal
mockFetch.mock("PUT@/blog/posts", async (req) => {
return new Response(/* ... */);
});
myKy.put("blog/posts", {
/* ... */
});
```
You can destructure it, too.
```typescript
const { fetch, mock, remove, reset} = mf.sandbox();
```
## Credits
**[@eliassjogreen]**'s tiny router ([source][router]) does the bulk of the work.
It's general-purpose, but works great for Deno Deploy.
[@eliassjogreen]: https://github.com/eliassjogreen
[router]: https://crux.land/[email protected]