mockaton 8.1.4 → 8.1.6

package/README.md

@@ -12,6 +12,7 @@ By the way, [this browser
 extension](https://github.com/ericfortis/devtools-ext-tar-http-requests)
 can create a TAR of your XHR requests following that convention.
 
+### Dashboard Example
 
 <picture>
   <source media="(prefers-color-scheme: light)" srcset="./README-dashboard-light.png">
@@ -44,7 +45,7 @@ node --import=tsx my-mockaton.js
 ```
 
 
-## Running the Example Demo
+## Running the Example
 This demo uses the [sample-mocks/](./sample-mocks) directory of this repository.
 
 - Checkout this repo
@@ -57,8 +58,8 @@ Experiment with the Dashboard:
 
 - Pick a mock variant from the Mock dropdown (we’ll discuss
   them later)
-- Toggle the clock icon, which _Delays_ responses (e.g. for testing spinners)
-- Toggle _500_ button, which sends and _Internal Server Error_ on that endpoint
+- Toggle the 🕓 Clock button, which _Delays_ responses (e.g. for testing spinners)
+- Toggle the _500_ button, which sends and _Internal Server Error_ on that endpoint
 
 Finally, edit a mock file. You don’t need to restart Mockaton for that. The
 _Reset_ button is for registering newly added, removed, or renamed mocks.
@@ -92,10 +93,10 @@ _Reset_ button is for registering newly added, removed, or renamed mocks.
 Each route can have many mocks, which could either be:
 - Different response __status code__. For example, for testing error responses.
 - __Comment__ on the filename, which is anything within parentheses.
-  - e.g. `api/user(my-comment).POST.201.json`
+  - e.g. `api/login(locked out user).POST.423.json`
 
-Those alternatives can be manually selected in the dashboard
-UI, or programmatically, for instance, for setting up tests.
+Those alternatives can be manually selected on the dashboard, or
+programmatically (see **Commander API** section), for instance, for setting up tests.
 
 ### Default Mock for a Route
 You can add the comment: `(default)` to a filename.
@@ -215,8 +216,7 @@ Defaults to `/(\.DS_Store|~)$/`
 
 
 ### `delay?: number` 🕓
-The clock icon next to the mock selector is a checkbox for delaying a
-particular response. They are handy for testing spinners.
+The clock icon next to the mock selector is a checkbox for delaying a particular response.
 
 The delay is globally configurable via `Config.delay = 1200` (milliseconds).
 
@@ -228,7 +228,7 @@ For example, `Config.proxyFallback = 'http://example.com:8080'`
 
 ### `staticDir?: string`
 Files under `Config.staticDir` don’t use the filename convention.
-Also, they take precedence over the `GET` mocks in `Config.mockDir`.
+Also, they take precedence over the `GET` mocks in `Config.mocksDir`.
 
 For example, if you have two files for `GET /foo/bar.jpg`
 ```
@@ -249,8 +249,8 @@ The key is just a label used for selecting a particular cookie in the
 dashboard. In the dashboard, only one cookie can be selected. If you need
 more cookies you can inject additional cookies globally in `Config.extraHeaders`.
 
-`jwtCookie` has a hardcoded header and signature. In other
-words, it’s useful if you only care about its payload.
+By the way, there’s a `jwtCookie` helper, which has a hardcoded header and
+signature. In other words, it’s useful if you only care about its payload.
 
 ```js
 import { jwtCookie } from 'mockaton'
@@ -280,7 +280,7 @@ Config.extraHeaders = [
 ### `extraMimes?: { [fileExt: string]: string }`
 ```js
 Config.extraMimes = {
-  jpg: 'application/jpeg'
+  jpe: 'application/jpeg'
 }
 ```
 
@@ -364,7 +364,7 @@ Config.onReady = open
 
 ---
 
-## HTTP API
+## Commander API
 `Commander` is a wrapper for the Mockaton HTTP API.
 All of its methods return their `fetch` response promise.
 ```js

package/package.json

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