` | options to use |\n| response | `string \\| number \\| Response` | response to use |\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n### `delete(matcher, response): MockServer`\n\nRegister a mock for requests with method `DELETE`.\n\nReturns the `MockServer` instance.\n\n| Param | Type | Description |\n| -------- | ------------------------------------------------ | --------------- |\n| matcher | `string \\| RegExp \\| Omit` | options to use |\n| response | `string \\| number \\| Response` | response to use |\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n### `mock(matcher, response, options): MockServer`\n\n### `hasBeenCalledWith(matcher: Matcher): boolean`\n\nReturns `true` if the route has been called with the given `path` and `method`.\n\n### `hasBeenCalledTimes(times: number, matcher: Matcher): boolean`\n\nReturns `true` if the route has been called `times` times with the given `matcher`.\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"b826936de6e5d472ffa86a2c6717c94cd4b99cda","description":" ![\"mocaron\"](\"https://raw.githubusercontent.com/joshuajaco/mocaron/main/logo.png\")
![\"npm](\"https://img.shields.io/npm/dw/mocaron\")
coverage/lcov.info","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@0.1.0-beta.3","readme":"\n \n
\n
\n \n \n \n \n ![\"Coverage](\"https://coveralls.io/repos/github/joshuajaco/mocaron/badge.svg\")
\n \n \n ![\"code](\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\")
\n \n
\n
\n Simple express mock server with an API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`Options`](#options)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreates a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStarts the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStops the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks); // [{ matcher: \"/test\", response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\", request: } }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| times | `number` | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: \"/test\", response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ path: \"/test\", method: \"GET\", request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `Options`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------------------------------------- | --------------------------------- |\n| method | `string` \\| `undefined` | http method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`express.Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against |\n| headers | `Record` \\| `undefined` | headers to match against |\n| body | `string` \\| `object` \\| `undefined` | body to match against |\n\n## `MatcherFn`\n\nA function that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: express.Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | --------------------------- |\n| status | `number` \\| `undefined` | status code to respond with |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with |\n\n## `ResponseFn`\n\nA function that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns an [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: express.Request) => ResponseObj;\n```\n\n## `MockOptions`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous mocks matching the same request will be overwritten |\n\n## `Mock`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------- | ----------------------------------- |\n| request | [`express.Request`](https://expressjs.com/en/4x/api.html#req) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher thr request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"5eda61ff13cd5a16c26d3dc79bfc6d71a3f169f7","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-WxbeuF9T37kX2oPCnz1jrar67c6weExNu9TDBD69cbzl+jkIyxhDXK364W7ELGpXcrK27cei6lMegENGcP8ohw==","shasum":"e27c72e60cf0a13ea58af3102c92c944b8fe7a0b","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-0.1.0-beta.3.tgz","fileCount":12,"unpackedSize":32032,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEMCIQCN/LuOQWwR7hxEdml7uyxjY2KpaN1Wv9s3i4sUnoAZ6gIeHbQsBNujn4xvWh9CclVxxpjZaUftFaaKwXf1gMt7"}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_0.1.0-beta.3_1690667797281_0.048973199034396675"},"_hasShrinkwrap":false,"deprecated":"Deprecated"},"0.1.0-beta.4":{"name":"mocaron","version":"0.1.0-beta.4","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","coverage":"mkdir -p coverage && touch coverage/lcov.info && nyc report --reporter=text-lcov > coverage/lcov.info","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@0.1.0-beta.4","readme":"\n \n
\n
\n \n \n \n \n \n \n \n \n \n
\n
\n Simple express mock server with a flexible API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`Options`](#options)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreates a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStarts the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStops the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the http `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks); // [{ matcher: \"/test\", response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\", request: } }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| times | `number` | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: \"/test\", response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ path: \"/test\", method: \"GET\", request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `Options`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------------------------------------- | --------------------------------- |\n| method | `string` \\| `undefined` | http method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`express.Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against |\n| headers | `Record` \\| `undefined` | headers to match against |\n| body | `string` \\| `object` \\| `undefined` | body to match against |\n\n## `MatcherFn`\n\nA function that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: express.Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | --------------------------- |\n| status | `number` \\| `undefined` | status code to respond with |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with |\n\n## `ResponseFn`\n\nA function that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns an [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: express.Request) => ResponseObj;\n```\n\n## `MockOptions`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous mocks matching the same request will be overwritten |\n\n## `Mock`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nobject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------- | ----------------------------------- |\n| request | [`express.Request`](https://expressjs.com/en/4x/api.html#req) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher thr request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"374476616e3633c04a54a6f9d40929097d6a7203","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-/V6pAW+PauoIMC/XKoG+DPGeeUwYY111gRWC1C/z77UyQMgr+Q1Q2uWoOZ92iinu/NC8M6BFd3BQF5dRqefedg==","shasum":"005f2d552361925823c06ee55d5a0c6c173bb1a7","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-0.1.0-beta.4.tgz","fileCount":12,"unpackedSize":32066,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFiJSPR8T0mapuHebN/Dmiako7dKWJD0g2FRk5t7tAvxAiEA1T5OOYT4oyTUpusYGJQaWcX255sT41eB3YKsn8yzV48="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_0.1.0-beta.4_1690668272488_0.5762900226475476"},"_hasShrinkwrap":false,"deprecated":"Deprecated"},"0.1.0-beta.5":{"name":"mocaron","version":"0.1.0-beta.5","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@0.1.0-beta.5","readme":"\n \n \n \n
\n
\n \n \n \n \n \n \n \n \n \n
\n
\n Simple express mock server with a flexible API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n## Starting and stopping the mock server\n\nSee [`constructor()`](#constructoroptions-mockserver) [`start()`](#start-promisevoid) [`stop()`](#stop-promisevoid)\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\n// ...\n\nawait mockServer.stop();\n```\n\n## Registering a mock\n\nRegister a mock using [`mock()`](#mockmatcher-response-options-mockserver).\n\n```ts\nmockServer.mock(\n { path: \"/test\", method: \"GET\" },\n { status: 200, body: { message: \"Hello World\" } },\n);\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n## Method specific mocks\n\nYou can also register mocks that only match a specific HTTP method.\n\nSee [`get()`](#getmatcher-response-options-mockserver) [`post()`](#postmatcher-response-options-mockserver) [`patch()`](#patchmatcher-response-options-mockserver) [`delete()`](#deletematcher-response-options-mockserver)\n\n```ts\nmockServer\n .get(\"/test\", { status: 200, body: { message: \"Hello World\" } })\n .post(\"/test\", { status: 201, body: { message: \"Created\" } })\n .patch(\"/test\", { status: 200, body: { message: \"Updated\" } })\n .delete(\"/test\", { status: 204 });\n```\n\n## Unmatched requests\n\nIf a request does not match any of the registered mocks the server will respond with a 404 status code.\n\n```ts\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 404\n```\n\n## Ambiguous mocks\n\nIf two or more mocks match the same request the server will respond with a 404 status code.\n\n```ts\nmockServer.mock({ path: \"/foo\" }, \"foo\").mock({ path: \"/foo\" }, \"bar\");\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 404\n```\n\nYou can override this behavior by passing the [`overwrite`](#mockoptions) option to the last matching mock.\n\n```ts\nmockServer\n .mock({ path: \"/foo\" }, \"foo\")\n .mock({ path: \"/foo\" }, \"bar\", { overwrite: true });\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.text()); // bar\n```\n\n## Resetting the mock server\n\nCalling [`reset()`](#reset-void) will reset the mock server to its initial state.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nlet response = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 200\n\nmockServer.reset();\n\nresponse = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 404\n```\n\n## Testing\n\nSet up the mock server for each test using [`start()`](#start-promisevoid), [`stop()`](#stop-promisevoid) and [`reset()`](#reset-void).\n\n```ts\nimport { MockServer } from \"mocaron\";\nimport { beforeAll, afterAll, beforeEach, test, assert } from \"my-test-library\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nbeforeAll(() => mockServer.start());\nafterAll(() => mockServer.stop());\nbeforeEach(() => mockServer.reset());\n```\n\nTest that a mock has been called using [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n```ts\ntest(\"mock has been called\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledWith({ path: \"/test\" }));\n});\n```\n\nTest that a mock has been called a specific number of times using [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n```ts\ntest(\"mock has been called 3 times\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledTimes(3, { path: \"/test\" }));\n});\n```\n\nCustom assertions using [`calls()`](#calls-readonly-call).\n\n```ts\ntest(\"custom assertion\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.calls().length === 1);\n assert(mockServer.calls()[0].request.path === \"/test\");\n});\n```\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`Options`](#options)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreate a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStart the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStop the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks);\n// [{ matcher: { path: \"/test\" }, response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\" }, request: }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| times | `number` | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `Options`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| method | `string` \\| `undefined` | HTTP method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`express.Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against.
Parameters explicitly set to `undefined` will not match when provided. |\n| headers | `Record` \\| `undefined` | headers to match against.
Headers explicitly set to `undefined` will not match when provided. |\n| body | `string` \\| `object` \\| `undefined` | body to match against.
If an `object` is given it will be compared to the request body parsed as JSON. |\n\n## `MatcherFn`\n\nFunction that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: express.Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | ---------------------------------------------------------------------------------------- |\n| status | `number` \\| `undefined` | status code to respond with (defaults to `200`) |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with.
If an `object` is given it will be converted to a JSON string. |\n\n## `ResponseFn`\n\nFunction that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns a [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: express.Request) => ResponseObj;\n```\n\n## `MockOptions`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous [ambiguous mocks](#ambiguous-mocks) matching the same request will be overwritten |\n\n## `Mock`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------- | ----------------------------------- |\n| request | [`express.Request`](https://expressjs.com/en/4x/api.html#req) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher the request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"d30240c39a7f59d5b62c4598419844f36385e30e","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-nlX1hX+tTQD131S3Gwv4CSwv19DVtF7pzaaEXnWnPQCKQwdt5LWEta2sjfOObJxx5luw/fiOVZfspMv7k6EfAQ==","shasum":"83a2401a786d96b202ae8bd16fa4a6eb65e0eaef","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-0.1.0-beta.5.tgz","fileCount":12,"unpackedSize":56559,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC1+t9qIzm2pmojCyb+89UZ+WvxjKYaVevfJX1f/XLXuwIgYCnXTUcWVMAnl2aQVewfrPBYSjdZgLKTwx22ma5tc0g="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_0.1.0-beta.5_1690735344990_0.5689203734711588"},"_hasShrinkwrap":false,"deprecated":"Deprecated"},"0.1.0-beta.6":{"name":"mocaron","version":"0.1.0-beta.6","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@0.1.0-beta.6","readme":"\n \n \n \n
\n
\n \n \n \n \n \n \n \n \n \n
\n
\n Simple express mock server with a flexible API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n## Starting and stopping the mock server\n\nSee [`constructor()`](#constructoroptions-mockserver) [`start()`](#start-promisevoid) [`stop()`](#stop-promisevoid)\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\n// ...\n\nawait mockServer.stop();\n```\n\n## Registering a mock\n\nRegister a mock using [`mock()`](#mockmatcher-response-options-mockserver).\n\n```ts\nmockServer.mock(\n { path: \"/test\", method: \"GET\" },\n { status: 200, body: { message: \"Hello World\" } },\n);\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n## Method specific mocks\n\nYou can also register mocks that only match a specific HTTP method.\n\nSee [`get()`](#getmatcher-response-options-mockserver) [`post()`](#postmatcher-response-options-mockserver) [`patch()`](#patchmatcher-response-options-mockserver) [`delete()`](#deletematcher-response-options-mockserver)\n\n```ts\nmockServer\n .get(\"/test\", { status: 200, body: { message: \"Hello World\" } })\n .post(\"/test\", { status: 201, body: { message: \"Created\" } })\n .patch(\"/test\", { status: 200, body: { message: \"Updated\" } })\n .delete(\"/test\", { status: 204 });\n```\n\n## Unmatched requests\n\nIf a request does not match any of the registered mocks the server will respond with a 404 status code.\n\n```ts\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 404\n```\n\n## Ambiguous mocks\n\nIf two or more mocks match the same request the server will respond with a 404 status code.\n\n```ts\nmockServer.mock({ path: \"/foo\" }, \"foo\").mock({ path: \"/foo\" }, \"bar\");\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 404\n```\n\nYou can override this behavior by passing the [`overwrite`](#mockoptions) option to the last matching mock.\n\n```ts\nmockServer\n .mock({ path: \"/foo\" }, \"foo\")\n .mock({ path: \"/foo\" }, \"bar\", { overwrite: true });\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.text()); // bar\n```\n\n## Resetting the mock server\n\nCalling [`reset()`](#reset-void) will reset the mock server to its initial state.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nlet response = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 200\n\nmockServer.reset();\n\nresponse = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 404\n```\n\n## Testing\n\nSet up the mock server for each test using [`start()`](#start-promisevoid), [`stop()`](#stop-promisevoid) and [`reset()`](#reset-void).\n\n```ts\nimport { MockServer } from \"mocaron\";\nimport { beforeAll, afterAll, beforeEach, test, assert } from \"my-test-library\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nbeforeAll(() => mockServer.start());\nafterAll(() => mockServer.stop());\nbeforeEach(() => mockServer.reset());\n```\n\nTest that a mock has been called using [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n```ts\ntest(\"mock has been called\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledWith({ path: \"/test\" }));\n});\n```\n\nTest that a mock has been called a specific number of times using [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n```ts\ntest(\"mock has been called 3 times\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledTimes(3, { path: \"/test\" }));\n});\n```\n\nCustom assertions using [`calls()`](#calls-readonly-call).\n\n```ts\ntest(\"custom assertion\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.calls().length === 1);\n assert(mockServer.calls()[0].request.path === \"/test\");\n});\n```\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`Options`](#options)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreate a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStart the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStop the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks);\n// [{ matcher: { path: \"/test\" }, response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\" }, request: }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| times | `number` | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `Options`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| method | `string` \\| `undefined` | HTTP method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`express.Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against.
Parameters explicitly set to `undefined` will not match when provided. |\n| headers | `Record` \\| `undefined` | headers to match against.
Headers explicitly set to `undefined` will not match when provided. |\n| body | `string` \\| `object` \\| `undefined` | body to match against.
If an `object` is given it will be compared to the request body parsed as JSON. |\n\n## `MatcherFn`\n\nFunction that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: express.Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | ---------------------------------------------------------------------------------------- |\n| status | `number` \\| `undefined` | status code to respond with (defaults to `200`) |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with.
If an `object` is given it will be converted to a JSON string. |\n\n## `ResponseFn`\n\nFunction that takes an [`express.Request`](https://expressjs.com/en/4x/api.html#req) and returns a [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: express.Request) => ResponseObj;\n```\n\n## `MockOptions`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous [ambiguous mocks](#ambiguous-mocks) matching the same request will be overwritten |\n\n## `Mock`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ------------------------------------------------------------- | ----------------------------------- |\n| request | [`express.Request`](https://expressjs.com/en/4x/api.html#req) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher the request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"6008b27e6c8dc57a4ea4034f37c390101226c8e8","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-GnubWLec0jviGV5rf8RKId7hNsE/5O+yRLCxFrb/Hf6hLhzMKf0PYh6Vz5Ss0ugzyTdwZouoRKcU8VTghkujXA==","shasum":"1391646c578695b51c46b62b0865935b91403c45","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-0.1.0-beta.6.tgz","fileCount":12,"unpackedSize":55267,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEaQoaG3gsoFioC3SM2V0quUehsxUthsNZv6Yiv0ZxCHAiEA04ac7yJF0MeJARIR/OuB7TZWm8PadbqH/Zio6Xd0Rik="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_0.1.0-beta.6_1690743463394_0.9806578064926992"},"_hasShrinkwrap":false,"deprecated":"Deprecated"},"0.1.0-beta.7":{"name":"mocaron","version":"0.1.0-beta.7","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@0.1.0-beta.7","readme":"\n \n \n \n
\n
\n \n \n \n \n \n \n \n \n \n
\n
\n Simple express mock server with a flexible API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n## Starting and stopping the mock server\n\nSee [`constructor()`](#constructoroptions-mockserver) [`start()`](#start-promisevoid) [`stop()`](#stop-promisevoid)\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\n// ...\n\nawait mockServer.stop();\n```\n\n## Registering a mock\n\nRegister a mock using [`mock()`](#mockmatcher-response-options-mockserver).\n\n```ts\nmockServer.mock(\n { path: \"/test\", method: \"GET\" },\n { status: 200, body: { message: \"Hello World\" } },\n);\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n## Method specific mocks\n\nYou can also register mocks that only match a specific HTTP method.\n\nSee [`get()`](#getmatcher-response-options-mockserver) [`post()`](#postmatcher-response-options-mockserver) [`put()`](#putmatcher-response-options-mockserver) [`patch()`](#patchmatcher-response-options-mockserver) [`delete()`](#deletematcher-response-options-mockserver)\n\n```ts\nmockServer\n .get(\"/test\", { status: 200, body: { message: \"Hello World\" } })\n .post(\"/test\", { status: 201, body: { message: \"Created\" } })\n .put(\"/test\", { status: 200, body: { message: \"Replaced\" } })\n .patch(\"/test\", { status: 200, body: { message: \"Updated\" } })\n .delete(\"/test\", { status: 204 });\n```\n\n## Unmatched requests\n\nIf a request does not match any of the registered mocks the server will respond with a 404 status code.\n\n```ts\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 404\n```\n\n## Ambiguous mocks\n\nIf two or more mocks match the same request the server will respond with a 404 status code.\n\n```ts\nmockServer.mock({ path: \"/foo\" }, \"foo\").mock({ path: \"/foo\" }, \"bar\");\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 404\n```\n\nYou can override this behavior by passing the [`overwrite`](#mockoptions) option to the last matching mock.\n\n```ts\nmockServer\n .mock({ path: \"/foo\" }, \"foo\")\n .mock({ path: \"/foo\" }, \"bar\", { overwrite: true });\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.text()); // bar\n```\n\n## Resetting the mock server\n\nCalling [`reset()`](#reset-void) will reset the mock server to its initial state.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nlet response = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 200\n\nmockServer.reset();\n\nresponse = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 404\n```\n\n## Testing\n\nSet up the mock server for each test using [`start()`](#start-promisevoid), [`stop()`](#stop-promisevoid) and [`reset()`](#reset-void).\n\n```ts\nimport { MockServer } from \"mocaron\";\nimport { beforeAll, afterAll, beforeEach, test, assert } from \"my-test-library\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nbeforeAll(() => mockServer.start());\nafterAll(() => mockServer.stop());\nbeforeEach(() => mockServer.reset());\n```\n\nTest that a mock has been called using [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n```ts\ntest(\"mock has been called\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledWith({ path: \"/test\" }));\n});\n```\n\nTest that a mock has been called a specific number of times using [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n```ts\ntest(\"mock has been called 3 times\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledTimes(3, { path: \"/test\" }));\n});\n```\n\nCustom assertions using [`calls()`](#calls-readonly-call).\n\n```ts\ntest(\"custom assertion\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.calls().length === 1);\n assert(mockServer.calls()[0].request.path === \"/test\");\n});\n```\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`put()`](#putmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`Options`](#options)\n- [`Request`](#request)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreate a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStart the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStop the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `put(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PUT` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.put(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PUT\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks);\n// [{ matcher: { path: \"/test\" }, response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\" }, request: }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| times | `number` | - |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `Options`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Request`\n\nType alias for [`express.Request`](https://expressjs.com/en/4x/api.html#req) with the `body` property typed as `Buffer` | `undefined`.\n\n```ts\ntype Request = express.Request<{}, unknown, Buffer | undefined>;\n```\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| method | `string` \\| `undefined` | HTTP method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against.
Parameters explicitly set to `undefined` will not match when provided. |\n| headers | `Record` \\| `undefined` | headers to match against.
Headers explicitly set to `undefined` will not match when provided. |\n| body | `string` \\| `object` \\| `undefined` | body to match against.
If an `object` is given it will be compared to the request body parsed as JSON. |\n\n## `MatcherFn`\n\nFunction that takes a [`Request`](#request) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | ---------------------------------------------------------------------------------------- |\n| status | `number` \\| `undefined` | status code to respond with (defaults to `200`) |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with.
If an `object` is given it will be converted to a JSON string. |\n\n## `ResponseFn`\n\nFunction that takes a [`Request`](#request) and returns a [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: Request) => ResponseObj;\n```\n\n## `MockOptions`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous [ambiguous mocks](#ambiguous-mocks) matching the same request will be overwritten |\n\n## `Mock`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------- | ----------------------------------- |\n| request | [`Request`](#request) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher the request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"dc87a0d0076fe16ac0d7a2707a7d3633cbeaaa9b","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-KvaaTPh7k76McK/Ak6TOlnps6OP5FzQTRJXatEa0rtJY8qWOaOaGjVsC/WASRwcQfwIm7xb69wHc35AbnrxFrQ==","shasum":"2955451bb1a7a049539a5c381b07ab3a57f1ae1e","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-0.1.0-beta.7.tgz","fileCount":12,"unpackedSize":60921,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCLLVJmB3n4+27ICjA4iZOO/cTrd+RTLzlmyZap1qUzaQIhAOzHpNnRg4L+TmzD49KYUVPTuYh83FyzOPNDPVpPTcMA"}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_0.1.0-beta.7_1690792180079_0.12544123846050037"},"_hasShrinkwrap":false,"deprecated":"Deprecated"},"0.3.0":{"name":"mocaron","version":"0.3.0","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@0.3.0","gitHead":"03a46a0f7ea3d3aebe6a76bdda07c5a216f3a9df","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-BbMVLVAv5VKd3Fx7cfwULeUcx2FWanGIRJFcTrlRtGe7aTETiZo2Fcigu7zEwI+v3cj88iluT5RGH948JuSaqw==","shasum":"46d40e940c6a096c108532c6e39271c71837eba6","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-0.3.0.tgz","fileCount":12,"unpackedSize":60914,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCnDCKPe8vx8IA7XXk4BybSYCvC4szOxK0nXSIbHRP41AIgIt/uTBNQEE38LWSMW032yYciQiesKbb+T+Dnak5Rerc="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_0.3.0_1690795555458_0.3100523436043612"},"_hasShrinkwrap":false,"deprecated":"Deprecated"},"1.0.0":{"name":"mocaron","version":"1.0.0","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test tests/run.ts","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.17","body-parser":"^1.20.2","deep-equal":"^2.2.2","express":"^4.18.2"},"devDependencies":{"@types/deep-equal":"^1.0.1","@typescript-eslint/eslint-plugin":"^6.2.0","@typescript-eslint/parser":"^6.2.0","eslint":"^8.46.0","eslint-config-prettier":"^8.9.0","get-port-please":"^3.0.1","node-mocks-http":"^1.12.2","nyc":"^15.1.0","prettier":"^3.0.0","rimraf":"^5.0.1","ts-node":"^10.9.1","typescript":"^5.1.6"},"_id":"mocaron@1.0.0","gitHead":"75f43b2afc457d86bca634c897ab58fe7fb65352","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"20.5.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-aCA29oV835sxzZEqjPLqrlLE2ZQ7ptrjzsZycVkwoiwBcx3K4WB7dxKRi40q6DWFi9MUDL3WAXWDUs2FjlVLJg==","shasum":"3b8161143610fbbd778963e78081bd0746b46f12","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-1.0.0.tgz","fileCount":12,"unpackedSize":60914,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAVMhsahS5GCIjUzJlrXTrW48hcxhrNoZr0Rkc22QPePAiEAsRyWuB80q5t+TeWJ3l1u8CRZYDk6bDTomQ+YCW+SJdg="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_1.0.0_1690795939847_0.8577146318193043"},"_hasShrinkwrap":false},"1.1.0-beta.0":{"name":"mocaron","version":"1.1.0-beta.0","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test \"**/*.test.ts\"","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.21","body-parser":"^1.20.2","deep-equal":"^2.2.3","express":"^4.19.2","jest-diff":"^29.7.0"},"devDependencies":{"@types/deep-equal":"^1.0.4","@typescript-eslint/eslint-plugin":"^7.7.0","@typescript-eslint/parser":"^7.7.0","eslint":"^8.57.0","eslint-config-prettier":"^9.1.0","get-port-please":"^3.1.2","node-mocks-http":"^1.14.1","nyc":"^15.1.0","prettier":"^3.2.5","rimraf":"^5.0.5","ts-node":"^10.9.2","typescript":"^5.4.5"},"_id":"mocaron@1.1.0-beta.0","readme":"\n \n \n \n
\n
\n \n \n \n \n \n \n \n \n \n
\n
\n Simple express mock server with a flexible API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n## Starting and stopping the mock server\n\nSee [`constructor()`](#constructoroptions-mockserver) [`start()`](#start-promisevoid) [`stop()`](#stop-promisevoid)\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\n// ...\n\nawait mockServer.stop();\n```\n\n## Registering a mock\n\nRegister a mock using [`mock()`](#mockmatcher-response-options-mockserver).\n\n```ts\nmockServer.mock(\n { path: \"/test\", method: \"GET\" },\n { status: 200, body: { message: \"Hello World\" } },\n);\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n## Method specific mocks\n\nYou can also register mocks that only match a specific HTTP method.\n\nSee [`get()`](#getmatcher-response-options-mockserver) [`post()`](#postmatcher-response-options-mockserver) [`put()`](#putmatcher-response-options-mockserver) [`patch()`](#patchmatcher-response-options-mockserver) [`delete()`](#deletematcher-response-options-mockserver)\n\n```ts\nmockServer\n .get(\"/test\", { status: 200, body: { message: \"Hello World\" } })\n .post(\"/test\", { status: 201, body: { message: \"Created\" } })\n .put(\"/test\", { status: 200, body: { message: \"Replaced\" } })\n .patch(\"/test\", { status: 200, body: { message: \"Updated\" } })\n .delete(\"/test\", { status: 204 });\n```\n\n## Unmatched requests\n\nIf a request does not match any of the registered mocks the server will respond with a 404 status code.\n\n```ts\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 404\n```\n\n## Ambiguous mocks\n\nIf two or more mocks match the same request the server will respond with a 404 status code.\n\n```ts\nmockServer.mock({ path: \"/foo\" }, \"foo\").mock({ path: \"/foo\" }, \"bar\");\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 404\n```\n\nYou can override this behavior by passing the [`overwrite`](#mockoptions) option to the last matching mock.\n\n```ts\nmockServer\n .mock({ path: \"/foo\" }, \"foo\")\n .mock({ path: \"/foo\" }, \"bar\", { overwrite: true });\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.text()); // bar\n```\n\n## Resetting the mock server\n\nCalling [`reset()`](#reset-void) will reset the mock server to its initial state.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nlet response = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 200\n\nmockServer.reset();\n\nresponse = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 404\n```\n\n## Testing\n\nSet up the mock server for each test using [`start()`](#start-promisevoid), [`stop()`](#stop-promisevoid) and [`reset()`](#reset-void).\n\n```ts\nimport { MockServer } from \"mocaron\";\nimport { beforeAll, afterAll, beforeEach, test, assert } from \"my-test-library\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nbeforeAll(() => mockServer.start());\nafterAll(() => mockServer.stop());\nbeforeEach(() => mockServer.reset());\n```\n\nTest that a mock has been called using [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n```ts\ntest(\"mock has been called\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledWith({ path: \"/test\" }));\n});\n```\n\nTest that a mock has been called a specific number of times using [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n```ts\ntest(\"mock has been called 3 times\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledTimes(3, { path: \"/test\" }));\n});\n```\n\nCustom assertions using [`calls()`](#calls-readonly-call).\n\n```ts\ntest(\"custom assertion\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.calls().length === 1);\n assert(mockServer.calls()[0].request.path === \"/test\");\n});\n```\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`put()`](#putmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`countCalls()`](#countcallsmatcher-number)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`ExpectationMessage`](#expectationmessage)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmockserver-matcher-string)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimesmockserver-times-matcher-string)\n- [`Options`](#options)\n- [`Request`](#request)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreate a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStart the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStop the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `put(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PUT` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.put(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PUT\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks);\n// [{ matcher: { path: \"/test\" }, response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\" }, request: }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| times | `number` | - |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `countCalls(matcher): number`\n\nCount the number of times the server was called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns the number of times the server has been called with the given `matcher`.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.countCalls({ path: \"/test\" })); // 0\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.countCalls({ path: \"/test\" })); // 1\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `ExpectationMessage`\n\n### `hasBeenCalledWith(mockServer, matcher): string`\n\nFormat an expectation message for [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n| Param | Type | Default |\n| ---------- | --------------------------- | ------- |\n| mockServer | [`MockServer`](#mockserver) | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns a string with the formatted expectation message.\n\n#### Example\n\n```ts\nif (!mockServer.hasBeenCalledWith(matcher)) {\n throw new Error(ExpectationMessage.hasBeenCalledWith(mockServer, matcher));\n}\n```\n\n### `hasBeenCalledTimes(mockServer, times, matcher): string`\n\nFormat an expectation message for [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n| Param | Type | Default |\n| ---------- | --------------------------- | ------- |\n| mockServer | [`MockServer`](#mockserver) | - |\n| times | number | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns a string with the formatted expectation message.\n\n#### Example\n\n```ts\nif (!mockServer.hasBeenCalledTimes(mockServer, 2, matcher)) {\n throw new Error(\n ExpectationMessage.hasBeenCalledTimes(mockServer, 2, matcher),\n );\n}\n```\n\n## `Options`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Request`\n\nType alias for [`express.Request`](https://expressjs.com/en/4x/api.html#req) with the `body` property typed as `Buffer` | `undefined`.\n\n```ts\ntype Request = express.Request<{}, unknown, Buffer | undefined>;\n```\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| method | `string` \\| `undefined` | HTTP method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against.
Parameters explicitly set to `undefined` will not match when provided. |\n| headers | `Record` \\| `undefined` | headers to match against.
Headers explicitly set to `undefined` will not match when provided. |\n| body | `string` \\| `object` \\| `undefined` | body to match against.
If an `object` is given it will be compared to the request body parsed as JSON. |\n\n## `MatcherFn`\n\nFunction that takes a [`Request`](#request) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | ---------------------------------------------------------------------------------------- |\n| status | `number` \\| `undefined` | status code to respond with (defaults to `200`) |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with.
If an `object` is given it will be converted to a JSON string. |\n| delay | `number` \\| `undefined` | delay in milliseconds before responding |\n\n## `ResponseFn`\n\nFunction or async function that takes a [`Request`](#request) and returns a [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: Request) => ResponseObj | Promise;\n```\n\n## `MockOptions`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous [ambiguous mocks](#ambiguous-mocks) matching the same request will be overwritten |\n\n## `Mock`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------- | ----------------------------------- |\n| request | [`Request`](#request) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher the request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","gitHead":"6794e4223af7c9141be51c363da7584fffd7d2d9","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"21.7.3","_npmVersion":"10.5.0","dist":{"integrity":"sha512-pwVuiIWCvFFkKovGc/mWcU9icb6WstN3bHhq3fTXYH+bAPD6enBWL8LUH2DFYZnxeQF4r1XQ1w1oNVI0wRsqNw==","shasum":"95dda0538b8d6a334bde24f66bf0ba298691e1ac","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-1.1.0-beta.0.tgz","fileCount":15,"unpackedSize":75898,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBnuyrqW8lBkRyZ3wkGbwji86L1vKzf+BSO1nu8AFK9mAiEAwGLijHQV9qu0orFU5DeenuMj1yFV/cQ0KAE+SeuARG0="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_1.1.0-beta.0_1713444256863_0.27062660592518806"},"_hasShrinkwrap":false},"1.1.0":{"name":"mocaron","version":"1.1.0","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"],"repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"license":"MIT","exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","format":"prettier -w .","format:check":"prettier -c .","lint":"eslint --ignore-path .gitignore --max-warnings 0 .","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run build","test":"nyc -r=lcov -r=text node --trace-warnings -r ts-node/register --test \"**/*.test.ts\"","typecheck":"tsc"},"dependencies":{"@types/express":"^4.17.21","body-parser":"^1.20.2","deep-equal":"^2.2.3","express":"^4.19.2","jest-diff":"^29.7.0"},"devDependencies":{"@types/deep-equal":"^1.0.4","@typescript-eslint/eslint-plugin":"^7.7.0","@typescript-eslint/parser":"^7.7.0","eslint":"^8.57.0","eslint-config-prettier":"^9.1.0","get-port-please":"^3.1.2","node-mocks-http":"^1.14.1","nyc":"^15.1.0","prettier":"^3.2.5","rimraf":"^5.0.5","ts-node":"^10.9.2","typescript":"^5.4.5"},"_id":"mocaron@1.1.0","gitHead":"86271c05e13643c2d129e7fd899c13bb53eee9d0","bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"homepage":"https://github.com/joshuajaco/mocaron#readme","_nodeVersion":"21.7.3","_npmVersion":"10.5.0","dist":{"integrity":"sha512-92qhosYIr6HdGhiYU3PUufpuVNZQfON8HylqlUy3QE+EIy0adv5nPz6/RBUdlIkR8LuKE5/c/IG5bmttXV/ZxA==","shasum":"28433c11577a83d73fc7aaeee4e8ac18aa1ec0c5","tarball":"https://registry.npmjs.org/mocaron/-/mocaron-1.1.0.tgz","fileCount":15,"unpackedSize":75891,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID1+FZwbJh3Asf4jpciqwshQlz3DucQ3vsNg6NYTP8IqAiBoqbCdhedcFAttsDmUyefqmgcwckq/KGHdb7XiLAUUpw=="}]},"_npmUser":{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"},"directories":{},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mocaron_1.1.0_1713445766314_0.9598133020534201"},"_hasShrinkwrap":false}},"time":{"created":"2022-07-15T14:11:46.398Z","0.0.0-empty":"2022-07-15T14:11:46.607Z","modified":"2024-04-18T13:09:26.685Z","0.0.1":"2022-07-21T17:38:11.677Z","0.0.2":"2022-07-22T09:06:06.153Z","0.0.3-alpha.0":"2023-07-27T08:22:13.255Z","0.0.3-alpha.1":"2023-07-27T08:25:05.574Z","0.1.0-beta.0":"2023-07-29T11:20:06.435Z","0.1.0-beta.1":"2023-07-29T11:22:26.433Z","0.1.0-beta.2":"2023-07-29T15:21:08.274Z","0.1.0-beta.3":"2023-07-29T21:56:37.444Z","0.1.0-beta.4":"2023-07-29T22:04:32.637Z","0.1.0-beta.5":"2023-07-30T16:42:25.184Z","0.1.0-beta.6":"2023-07-30T18:57:43.614Z","0.1.0-beta.7":"2023-07-31T08:29:40.278Z","0.3.0":"2023-07-31T09:25:55.678Z","1.0.0":"2023-07-31T09:32:20.038Z","1.1.0-beta.0":"2024-04-18T12:44:17.057Z","1.1.0":"2024-04-18T13:09:26.457Z"},"maintainers":[{"name":"joshuajaco","email":"joshua.jacobowitz@yahoo.de"}],"readme":"\n \n \n \n
\n
\n \n \n \n \n \n \n \n \n \n
\n
\n Simple express mock server with a flexible API inspired by fetch-mock\n
\n\n---\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Usage](#usage)\n- [API](#api)\n- [Changelog](#changelog)\n- [License](#license)\n\n---\n\n# Installation\n\n```bash\n# npm\nnpm install -D mocaron\n\n# yarn\nyarn add -D mocaron\n\n# pnpm\npnpm add -D mocaron\n```\n\n# Quick Start\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\nmockServer.get(\"/test\", { status: 200, body: { message: \"Hello World\" } });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n\nawait mockServer.stop();\n```\n\n# Usage\n\n## Starting and stopping the mock server\n\nSee [`constructor()`](#constructoroptions-mockserver) [`start()`](#start-promisevoid) [`stop()`](#stop-promisevoid)\n\n```ts\nimport { MockServer } from \"mocaron\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nawait mockServer.start();\n\n// ...\n\nawait mockServer.stop();\n```\n\n## Registering a mock\n\nRegister a mock using [`mock()`](#mockmatcher-response-options-mockserver).\n\n```ts\nmockServer.mock(\n { path: \"/test\", method: \"GET\" },\n { status: 200, body: { message: \"Hello World\" } },\n);\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n## Method specific mocks\n\nYou can also register mocks that only match a specific HTTP method.\n\nSee [`get()`](#getmatcher-response-options-mockserver) [`post()`](#postmatcher-response-options-mockserver) [`put()`](#putmatcher-response-options-mockserver) [`patch()`](#patchmatcher-response-options-mockserver) [`delete()`](#deletematcher-response-options-mockserver)\n\n```ts\nmockServer\n .get(\"/test\", { status: 200, body: { message: \"Hello World\" } })\n .post(\"/test\", { status: 201, body: { message: \"Created\" } })\n .put(\"/test\", { status: 200, body: { message: \"Replaced\" } })\n .patch(\"/test\", { status: 200, body: { message: \"Updated\" } })\n .delete(\"/test\", { status: 204 });\n```\n\n## Unmatched requests\n\nIf a request does not match any of the registered mocks the server will respond with a 404 status code.\n\n```ts\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 404\n```\n\n## Ambiguous mocks\n\nIf two or more mocks match the same request the server will respond with a 404 status code.\n\n```ts\nmockServer.mock({ path: \"/foo\" }, \"foo\").mock({ path: \"/foo\" }, \"bar\");\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 404\n```\n\nYou can override this behavior by passing the [`overwrite`](#mockoptions) option to the last matching mock.\n\n```ts\nmockServer\n .mock({ path: \"/foo\" }, \"foo\")\n .mock({ path: \"/foo\" }, \"bar\", { overwrite: true });\n\nconst response = await fetch(\"http://localhost:3000/foo\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.text()); // bar\n```\n\n## Resetting the mock server\n\nCalling [`reset()`](#reset-void) will reset the mock server to its initial state.\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nlet response = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 200\n\nmockServer.reset();\n\nresponse = await fetch(\"http://localhost:3000/test\");\nconsole.log(response.status); // 404\n```\n\n## Testing\n\nSet up the mock server for each test using [`start()`](#start-promisevoid), [`stop()`](#stop-promisevoid) and [`reset()`](#reset-void).\n\n```ts\nimport { MockServer } from \"mocaron\";\nimport { beforeAll, afterAll, beforeEach, test, assert } from \"my-test-library\";\n\nconst mockServer = new MockServer({ port: 3000 });\n\nbeforeAll(() => mockServer.start());\nafterAll(() => mockServer.stop());\nbeforeEach(() => mockServer.reset());\n```\n\nTest that a mock has been called using [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n```ts\ntest(\"mock has been called\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledWith({ path: \"/test\" }));\n});\n```\n\nTest that a mock has been called a specific number of times using [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n```ts\ntest(\"mock has been called 3 times\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.hasBeenCalledTimes(3, { path: \"/test\" }));\n});\n```\n\nCustom assertions using [`calls()`](#calls-readonly-call).\n\n```ts\ntest(\"custom assertion\", async () => {\n mockServer.get(\"/test\", { status: 200 });\n\n await fetch(\"http://localhost:3000/test\");\n\n assert(mockServer.calls().length === 1);\n assert(mockServer.calls()[0].request.path === \"/test\");\n});\n```\n\n# API\n\n- [`MockServer`](#mockserver)\n - [`constructor()`](#constructoroptions-mockserver)\n - [`start()`](#start-promisevoid)\n - [`stop()`](#stop-promisevoid)\n - [`port()`](#port-number)\n - [`mock()`](#mockmatcher-response-options-mockserver)\n - [`get()`](#getmatcher-response-options-mockserver)\n - [`post()`](#postmatcher-response-options-mockserver)\n - [`put()`](#putmatcher-response-options-mockserver)\n - [`patch()`](#patchmatcher-response-options-mockserver)\n - [`delete()`](#deletematcher-response-options-mockserver)\n - [`mocks()`](#mocks-readonly-mock)\n - [`calls()`](#calls-readonly-call)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean)\n - [`countCalls()`](#countcallsmatcher-number)\n - [`reset()`](#reset-void)\n - [`resetMocks()`](#resetmocks-void)\n - [`resetCalls()`](#resetcalls-void)\n- [`ExpectationMessage`](#expectationmessage)\n - [`hasBeenCalledWith()`](#hasbeencalledwithmockserver-matcher-string)\n - [`hasBeenCalledTimes()`](#hasbeencalledtimesmockserver-times-matcher-string)\n- [`Options`](#options)\n- [`Request`](#request)\n- [`Matcher`](#matcher)\n- [`MatcherObj`](#matcherobj)\n- [`MatcherFn`](#matcherfn)\n- [`Response`](#response)\n- [`ResponseObj`](#responseobj)\n- [`ResponseFn`](#responsefn)\n- [`MockOptions`](#mockoptions)\n- [`Mock`](#mock)\n- [`Call`](#call)\n\n## `MockServer`\n\n### `constructor(options): MockServer`\n\nCreate a new [`MockServer`](#mockserver) instance.\n\n| Param | Type | Default |\n| ------- | --------------------- | ------- |\n| options | [`Options`](#options) | - |\n\n#### Example\n\n```ts\nconst mockServer = new MockServer({ port: 3000 });\n```\n\n---\n\n### `start(): Promise`\n\nStart the mock server.\n\n#### Example\n\n```ts\nawait mockServer.start();\n```\n\n---\n\n### `stop(): Promise`\n\nStop the mock server.\n\n#### Example\n\n```ts\nawait mockServer.stop();\n```\n\n---\n\n### `port(): number`\n\nGet the port the mock server is running on.\n\n#### Example\n\n```ts\nconst port = mockServer.port();\nconsole.log(port); // 3000\n```\n\n---\n\n### `mock(matcher, response, options): MockServer`\n\nRegister a mock.\n\n| Param | Type | Default |\n| -------- | ----------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `get(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `GET` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\");\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `post(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `POST` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.post(\"/test\", {\n status: 201,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"POST\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 201\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `put(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PUT` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.put(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PUT\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `patch(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `PATCH` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.patch(\"/test\", {\n status: 200,\n body: { message: \"Hello World\" },\n});\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"PATCH\",\n body: JSON.stringify({ message: \"Hello World\" }),\n});\n\nconsole.log(response.status); // 200\nconsole.log(await response.json()); // { message: \"Hello World\" }\n```\n\n---\n\n### `delete(matcher, response, options): MockServer`\n\nRegister a mock that only responds to requests using the HTTP `DELETE` method.\n\n| Param | Type | Default |\n| -------- | --------------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`MatcherObj`](#matcherobj) | - |\n| response | `string` \\| `number` \\| [`Response`](#response) | - |\n| options | [`MockOptions`](#mockoptions) | `{}` |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path. \nIf `response` is a `string`, it will be used as the response body. \nIf `response` is a `number`, it will be used as the response status code.\n\nReturns the [`MockServer`](#mockserver) instance.\n\n#### Example\n\n```ts\nmockServer.delete(\"/test\", { status: 204 });\n\nconst response = await fetch(\"http://localhost:3000/test\", {\n method: \"DELETE\",\n});\n\nconsole.log(response.status); // 204\n```\n\n---\n\n### `mocks(): readonly Mock[]`\n\nGet all registered mocks.\n\nReturns an array of [`Mock`](#mock) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\n\nconst mocks = mockServer.mocks();\n\nconsole.log(mocks);\n// [{ matcher: { path: \"/test\" }, response: { status: 204 } }]\n```\n\n---\n\n### `calls(): readonly Call[]`\n\nGet all registered calls.\n\nReturns an array of [`Call`](#call) objects.\n\n#### Example\n\n```ts\nmockServer.mock({ path: \"/test\" }, { status: 204 });\nawait fetch(\"http://localhost:3000/test\");\n\nconst calls = mockServer.calls();\n\nconsole.log(calls);\n// [{ matcher: { path: \"/test\" }, request: }]\n```\n\n---\n\n### `hasBeenCalledWith(matcher): boolean`\n\nCheck if the route has been called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns `true` if the route has been called with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledWith({ path: \"/test\" })); // true\n```\n\n---\n\n### `hasBeenCalledTimes(times, matcher): boolean`\n\nCheck if the route has been called a certain number of times with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| times | `number` | - |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns `true` if the route has been called `times` times with the given `matcher`, `false` otherwise.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // true\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // false\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.hasBeenCalledTimes(0, { path: \"/test\" })); // false\nconsole.log(mockServer.hasBeenCalledTimes(1, { path: \"/test\" })); // true\n```\n\n---\n\n### `countCalls(matcher): number`\n\nCount the number of times the server was called with the given `matcher`.\n\n| Param | Type | Default |\n| ------- | --------------------------------------------- | ------- |\n| matcher | `string` \\| `RegExp` \\| [`Matcher`](#matcher) | - |\n\nIf `matcher` is a `string` or `RegExp`, it will be used to match the request path.\n\nReturns the number of times the server has been called with the given `matcher`.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.countCalls({ path: \"/test\" })); // 0\n\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.countCalls({ path: \"/test\" })); // 1\n```\n\n---\n\n### `reset(): void`\n\nReset all mocks and calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.reset();\n\nconsole.log(mockServer.mocks()); // []\nconsole.log(mockServer.calls()); // []\n```\n\n---\n\n### `resetMocks(): void`\n\nReset all mocks.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\n\nconsole.log(mockServer.mocks());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, response: { status: 200 } }]\n\nmockServer.resetMocks();\n\nconsole.log(mockServer.mocks()); // []\n```\n\n---\n\n### `resetCalls(): void`\n\nReset all calls.\n\n#### Example\n\n```ts\nmockServer.get(\"/test\", { status: 200 });\nawait fetch(\"http://localhost:3000/test\");\n\nconsole.log(mockServer.calls());\n// [{ matcher: { path: \"/test\", method: \"GET\" }, request: }]\n\nmockServer.resetCalls();\n\nconsole.log(mockServer.calls()); // []\n```\n\n## `ExpectationMessage`\n\n### `hasBeenCalledWith(mockServer, matcher): string`\n\nFormat an expectation message for [`hasBeenCalledWith()`](#hasbeencalledwithmatcher-boolean).\n\n| Param | Type | Default |\n| ---------- | --------------------------- | ------- |\n| mockServer | [`MockServer`](#mockserver) | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns a string with the formatted expectation message.\n\n#### Example\n\n```ts\nif (!mockServer.hasBeenCalledWith(matcher)) {\n throw new Error(ExpectationMessage.hasBeenCalledWith(mockServer, matcher));\n}\n```\n\n### `hasBeenCalledTimes(mockServer, times, matcher): string`\n\nFormat an expectation message for [`hasBeenCalledTimes()`](#hasbeencalledtimestimes-matcher-boolean).\n\n| Param | Type | Default |\n| ---------- | --------------------------- | ------- |\n| mockServer | [`MockServer`](#mockserver) | - |\n| times | number | - |\n| matcher | [`Matcher`](#matcher) | - |\n\nReturns a string with the formatted expectation message.\n\n#### Example\n\n```ts\nif (!mockServer.hasBeenCalledTimes(mockServer, 2, matcher)) {\n throw new Error(\n ExpectationMessage.hasBeenCalledTimes(mockServer, 2, matcher),\n );\n}\n```\n\n## `Options`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | -------- | ------------------------------ |\n| port | `number` | port to run the mock server on |\n\n## `Request`\n\nType alias for [`express.Request`](https://expressjs.com/en/4x/api.html#req) with the `body` property typed as `Buffer` | `undefined`.\n\n```ts\ntype Request = express.Request<{}, unknown, Buffer | undefined>;\n```\n\n## `Matcher`\n\nType alias for [`MatcherObj`](#matcherobj) | [`MatcherFn`](#matcherfn).\n\n```ts\ntype Matcher = MatcherObj | MatcherFn;\n```\n\n## `MatcherObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\n| method | `string` \\| `undefined` | HTTP method to match against |\n| path | `string` \\| `RegExp` \\| `undefined` | path to match against |\n| query | [`Request[\"query\"]`](https://expressjs.com/en/4x/api.html#req.query) \\| `undefined` | query parameters to match against.
Parameters explicitly set to `undefined` will not match when provided. |\n| headers | `Record` \\| `undefined` | headers to match against.
Headers explicitly set to `undefined` will not match when provided. |\n| body | `string` \\| `object` \\| `undefined` | body to match against.
If an `object` is given it will be compared to the request body parsed as JSON. |\n\n## `MatcherFn`\n\nFunction that takes a [`Request`](#request) and returns whether the request should match.\n\n```ts\ntype MatcherFn = (req: Request) => boolean;\n```\n\n## `Response`\n\nType alias for [`ResponseObj`](#responseobj) | [`ResponseFn`](#responsefn).\n\n```ts\ntype Response = ResponseObj | ResponseFn;\n```\n\n## `ResponseObj`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------------------------- | ---------------------------------------------------------------------------------------- |\n| status | `number` \\| `undefined` | status code to respond with (defaults to `200`) |\n| headers | `Record` \\| `undefined` | headers to respond with |\n| body | `string` \\| `object` \\| `undefined` | body to respond with.
If an `object` is given it will be converted to a JSON string. |\n| delay | `number` \\| `undefined` | delay in milliseconds before responding |\n\n## `ResponseFn`\n\nFunction or async function that takes a [`Request`](#request) and returns a [`ResponseObj`](#responseobj).\n\n```ts\ntype ResponseFn = (req: Request) => ResponseObj | Promise;\n```\n\n## `MockOptions`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| overwrite | `boolean` \\| `undefined` | when set to `true`,
previous [ambiguous mocks](#ambiguous-mocks) matching the same request will be overwritten |\n\n## `Mock`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | ----------------------------- | -------------------------------------------------- |\n| matcher | [`Matcher`](#matcher) | matcher to match against the request |\n| response | [`Response`](#response) | response the server will respond with when matched |\n| options | [`MockOptions`](#mockoptions) | see [`MockOptions`](#mockoptions) |\n\n## `Call`\n\nObject with the following properties:\n\n| Property | Type | Description |\n| -------- | --------------------- | ----------------------------------- |\n| request | [`Request`](#request) | request the server was called with |\n| matcher | [`Matcher`](#matcher) | matcher the request matched against |\n\n# Changelog\n\n[CHANGELOG.md](https://github.com/joshuajaco/mocaron/blob/main/CHANGELOG.md)\n\n# License\n\n[MIT](https://github.com/joshuajaco/mocaron/blob/main/LICENSE)\n","readmeFilename":"README.md","homepage":"https://github.com/joshuajaco/mocaron#readme","repository":{"type":"git","url":"git+https://github.com/joshuajaco/mocaron.git"},"bugs":{"url":"https://github.com/joshuajaco/mocaron/issues"},"license":"MIT","description":"Simple express mock server with a flexible API inspired by fetch-mock","keywords":["mock","mocking","mocks","mock-server","server","express","fetch-mock"]}
![\"mocaron\"/](\"./logo.png\"){kind=logo}
\n \n ![\"mocaron\"/](\"https://raw.githubusercontent.com/joshuajaco/mocaron/c5d4e625c9b7e58a020f20a512148b40b671daa1/logo.png\"){kind=logo}
\n \n