Merge pull request #35 from baabouj/feature/update-docs-to-include-la…

…test-features feat: update docs to include latest features
pactumjs · Aug 14, 2023 · 0a70866 · 0a70866
2 parents de569c9 + a81d9c8
commit 0a70866
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 3 deletions.
diff --git a/docs/api/mock/interaction.md b/docs/api/mock/interaction.md
@@ -16,6 +16,7 @@ An **interaction** adds behavior to the mock server.
 | request.path              | api path                                    |
 | request.pathParams        | api path params                             |
 | request.headers           | request headers                             |
+| request.cookies           | request cookies                             |
 | request.queryParams       | query parameters                            |
 | request.body              | request body                                |
 | request.graphQL           | graphQL details                             |
@@ -24,6 +25,7 @@ An **interaction** adds behavior to the mock server.
 | response                  | response details                            |
 | response.status           | response status code                        |
 | response.headers          | response headers                            |
+| response.cookies          | response cookies                            |
 | response.body             | response body                               |
 | response.file             | path of the file to return                  |
 | response.fixedDelay       | delays the response by ms                   |

diff --git a/docs/api/requests/returns.md b/docs/api/requests/returns.md
@@ -56,8 +56,10 @@ If the `path` starts with one of the value, it has a special meaning
 | `req.pathParams`  | Request path params               |
 | `req.queryParams` | Request query params              |
 | `req.headers`     | Request headers                   |
+| `req.cookies`     | Request cookies                   |
 | `res.body`        | Response body *(this is default)* |
-| `res.headers`     | Response headers                   |
+| `res.headers`     | Response headers                  |
+| `res.cookies`     | Response cookies                  |
 
 #### > custom_function (function)
 

diff --git a/docs/api/requests/stores.md b/docs/api/requests/stores.md
@@ -52,8 +52,10 @@ If the `path` starts with one of the value, it has a special meaning
 | `req.pathParams`  | Request path params               |
 | `req.queryParams` | Request query params              |
 | `req.headers`     | Request headers                   |
+| `req.cookies`     | Request cookies                   |
 | `res.body`        | Response body *(this is default)* |
-| `res.headers`     | Response headers                   |
+| `res.headers`     | Response headers                  |
+| `res.cookies`     | Response cookies                  |
 
 #### > handler_name (string)
 

diff --git a/docs/guides/data-management.md b/docs/guides/data-management.md
@@ -289,8 +289,10 @@ If the `json-query` starts with one of the value, it has a special meaning
 | `req.pathParams`  | Request path params               |
 | `req.queryParams` | Request query params              |
 | `req.headers`     | Request headers                   |
+| `req.cookies`     | Request cookies                   |
 | `res.body`        | Response body *(this is default)* |
-| `res.headers`     | Response headers                   |
+| `res.headers`     | Response headers                  |
+| `res.cookies`     | Response cookies                  |
 
 ## Loading Data
 

diff --git a/docs/guides/mock-server.md b/docs/guides/mock-server.md
@@ -239,6 +239,7 @@ For capturing other parts of the request,
 - `req.pathParams` - Request Path Params
 - `req.queryParams` - Request Query Params
 - `req.headers` - Request Headers
+- `req.cookies` - Request cookies
 - `req.body` - Request Body