bun-bagel is a mocking library specifically designed for Bun's fetch API. It enables developers to easily intercept fetch requests and provide custom mock responses, streamlining the development and testing process of Bun applications.
import { mock } from "bun-bagel";
// Register the mock for the example URL.
mock("https://example.com/api/users/*", { data: { name: "Foo" } });
// Make a fetch request to the mocked URL
const response = await fetch("https://example.com/api/users/123");
// Print the response body
console.log(await response.json());
{ name: "Foo" }
- Lightweight and easy to use: Get started in minutes with a simple, intuitive API.
- Flexible and powerful: Handle a wide range of mocking scenarios with ease.
- Built for Bun: Seamlessly integrates with Bun's runtime for a smooth developer experience.
- Thoroughly tested: Comes with a comprehensive test suite to ensure reliability.
bun install bun-bagel
import { describe, test, expect, afterEach } from "bun:test";
import { mock, clearMocks } from "bun-bagel";
describe("Unit Test", () => {
afterEach(() => {
clearMocks();
});
test("Mock Fetch", async () => {
// Register the mock for the example URL.
mock("https://example.com/api/users/*", { data: { name: "Foo" } });
// Call a function that uses the fetch method.
const response = await fetchSomeData();
// Print the response body
console.log(await response.json()); // => { name: "Foo" }
});
});
import { mock } from "bun-bagel";
import type { MockOptions } from "bun-bagel";
const options: MockOptions = {
method: "POST",
headers: { "x-foo-bar": "baz" },
response: {
data: { name: "Foo" },
}
};
// Register the mock for the example URL.
mock("https://example.com/api/users/*", options);
// Make a fetch request to the mocked URL
const response = await fetch("https://example.com/api/users/123", { headers: { "x-foo-bar": "baz" } });
// Requests without the headers will not be matched.
const response2 = await fetch("https://example.com/api/users/123");
// Check the response body.
console.log(await response.json()); // => { name: "Foo" }
import { mock } from "bun-bagel";
import type { MockOptions } from "bun-bagel";
const options: MockOptions = {
response: {
data: { name: "Foo" },
status: 404,
headers: { "x-foo-bar": "baz" },
}
};
// Register the mock for the example URL.
mock("https://example.com/api/users/*", options);
// Make a fetch request to the mocked URL
const response = await fetch("https://example.com/api/users/123");
// Check the status and headers.
console.log(response.status); // => 404
console.log(response.headers); // => { "x-foo-bar": "baz" }
This project is licensed under the terms of the MIT license. See the LICENSE file for details.