mockaton 8.2.21 → 8.2.22

package/README.md

@@ -17,8 +17,8 @@ By the way, [this browser
 extension](https://github.com/ericfortis/devtools-ext-tar-http-requests)
 can create a TAR of your requests following that convention.
 
-Nonetheless, you don’t need to mock all your APIs. If you don’t add
-a mock for some route, Mockaton can request it from your backend.
+Nonetheless, you don’t need to mock all your APIs. Mockaton
+can request from your backend the routes you don’t have mocks for.
 That’s done with `config.proxyFallback = 'http://mybackend'`
 
 ## Multiple Mock Variants
@@ -123,15 +123,6 @@ filename, such as `(demo-part1)`, `(demo-part2)`.
 - Reverse Proxies such as [Burp](https://portswigger.net/burp) are also handy for overriding responses.
 - [Mock Server Worker](https://mswjs.io)
 
----
-## Default Mock for a Route
-You can add the comment: `(default)` to a filename.
-Otherwise, the first file in **alphabetical order** wins.
-
-```
-api/user(default).GET.200.json
-```
-
 ---
 
 ## You can write JSON mocks in JavaScript or TypeScript
@@ -227,6 +218,15 @@ api/foo<b>(my comment)</b>.GET.200.json
 api/foo.GET.200.json
 </pre>
 
+### Default Mock for a Route
+You can add the comment: `(default)`. 
+Otherwise, the first file in **alphabetical order** wins.
+
+<pre>
+api/user<b>(default)</b>.GET.200.json
+</pre>
+
+
 ### Query String Params
 The query string is ignored when routing to it. In other words, it’s only used for
 documenting the URL contract.
@@ -238,9 +238,8 @@ Speaking of which, on Windows filenames containing "?" are [not
 permitted](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file), but since that’s part of the query string, it’s ignored anyway.
 
 
-### Index-like route
-For instance, if you have `api/foo/bar` and
-`api/foo`, you have two options:
+### Index-like routes
+If you have `api/foo` and `api/foo/bar`, you have two options:
 
 **Option A:** 
 ```
@@ -309,15 +308,13 @@ config.cookies = {
   })
 }
 ```
-The selected cookie is sent in every response in a `Set-Cookie` header.
+The selected cookie, which is the first one by default, is sent in every
+response in a `Set-Cookie` header. If you need to send more
+cookies, inject them globally in `config.extraHeaders`.
 
 By the way, the `jwtCookie` helper has a hardcoded header and signature.
 In other words, it’s useful only if you care about the payload.
 
-If you need to send more than one cookie,
-inject them globally in `config.extraHeaders`.
-
-
 
 ### `extraHeaders?: string[]`
 Note it’s a unidimensional array. The header name goes at even indices.
@@ -337,6 +334,8 @@ config.extraMimes = {
   jpe: 'application/jpeg'
 }
 ```
+These media types take precedence over the built-in
+[utils/mime.js](src/utils/mime.js), so you can override them.
 
 
 ### `plugins?: [filenameTester: RegExp, plugin: Plugin][]`
@@ -352,7 +351,7 @@ type Plugin = (
 ```
 Plugins are for processing mocks before sending them.
 
-Note: don’t call `response.end()`
+Note: don’t call `response.end()` on them.
 
 <details>
 <summary><b> See Plugin Examples </b></summary>
@@ -366,7 +365,7 @@ import { readFileSync } from 'node:js'
 import { jsToJsonPlugin } from 'mockaton'
 
 config.plugins = [
-  [/\.(js|ts)$/, jsToJsonPlugin], // Default 
+  [/\.(js|ts)$/, jsToJsonPlugin], // Default but you need to add it to your list if you need it
   [/\.yml$/, yamlToJsonPlugin],
   [/foo\.GET\.200\.txt$/, capitalizePlugin], // e.g. GET /api/foo would be capitalized
 ]
@@ -401,7 +400,7 @@ config.corsExposedHeaders = [] // headers you need to access in client-side JS
 
 
 ### `onReady?: (dashboardUrl: string) => void`
-This defaults to trying to open the dashboard in your default browser in macOS and
+This defaults to trying to open the dashboard in your default browser on macOS and
 Windows. For a more cross-platform utility, you could `npm install open` and pass it.
 ```js
 import open from 'open'

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "8.2.21",
+	"version": "8.2.22",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",