release version 5.2.0 (#748)

* bump version to 5.2.0 * fix docs * update changelog
contactlab · Oct 17, 2023 · de04c51 · de04c51
1 parent ea9eb6f
commit de04c51
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [5.2.0](https://github.com/contactlab/appy/releases/tag/5.2.0)
+
+**New Feature:**
+
+- Forward `RequestInfoInit` to `ResponseError` (#743)
+
 ## [5.1.0](https://github.com/contactlab/appy/releases/tag/5.1.0)
 
 **New Feature:**

diff --git a/README.md b/README.md
@@ -50,12 +50,13 @@ type ReqInput = RequestInfo | RequestInfoInit;
 type RequestInfoInit = [RequestInfo, RequestInit];
 ```
 
-`Resp<A>` is an object that carries the original `Response` from a `fetch()` call and the actual retrieved `data` (of type `A`).
+`Resp<A>` is an object that carries the original `Response` from a `fetch()` call, the actual retrieved `data` (of type `A`) and the request's input (optional).
 
 ```ts
 interface Resp<A> {
   response: Response;
   data: A;
+  input?: RequestInfoInit;
 }
 ```
 
@@ -75,7 +76,7 @@ interface RequestError {
 }
 ```
 
-`ResponseError` represents a response error. It carries the generated `Error` and the original `Response` object.
+`ResponseError` represents a response error. It carries the generated `Error`, the original `Response` object and the request's input (optional).
 
 ```ts
 interface ResponseError {

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,12 @@ nav_order: 2
 
 # Changelog
 
+## [5.2.0](https://github.com/contactlab/appy/releases/tag/5.2.0)
+
+**New Feature:**
+
+- Forward `RequestInfoInit` to `ResponseError` (#743)
+
 ## [5.1.0](https://github.com/contactlab/appy/releases/tag/5.1.0)
 
 **New Feature:**

diff --git a/docs/index.md b/docs/index.md
@@ -55,12 +55,13 @@ type ReqInput = RequestInfo | RequestInfoInit;
 type RequestInfoInit = [RequestInfo, RequestInit];
 ```
 
-`Resp<A>` is an object that carries the original `Response` from a `fetch()` call and the actual retrieved `data` (of type `A`).
+`Resp<A>` is an object that carries the original `Response` from a `fetch()` call, the actual retrieved `data` (of type `A`) and the request's input (optional).
 
 ```ts
 interface Resp<A> {
   response: Response;
   data: A;
+  input?: RequestInfoInit;
 }
 ```
 
@@ -80,7 +81,7 @@ interface RequestError {
 }
 ```
 
-`ResponseError` represents a response error. It carries the generated `Error` and the original `Response` object.
+`ResponseError` represents a response error. It carries the generated `Error`, the original `Response` object and the request's input (optional).
 
 ```ts
 interface ResponseError {

diff --git a/docs/modules/request.ts.md b/docs/modules/request.ts.md
@@ -68,7 +68,7 @@ Added in v4.0.0
 
 ## ResponseError (interface)
 
-`ResponseError` represents a response error. It carriess the generated `Error` and the original `Response` object.
+`ResponseError` represents a response error. It carriess the generated `Error`, the original `Response` object and the request's input (optional).
 
 **Signature**
 
@@ -179,7 +179,7 @@ Added in v4.0.0
 
 ## Resp (interface)
 
-`Resp<A>` is an object that carries the original `Response` from a `fetch()` call and the actual retrieved `data` (of type `A`).
+`Resp<A>` is an object that carries the original `Response` from a `fetch()` call, the actual retrieved `data` (of type `A`) and the request's input (optional).
 
 **Signature**
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@contactlab/appy",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "A functional wrapper around Fetch API",
   "main": "./index.js",
   "module": "./_es6/index.js",

diff --git a/src/request.ts b/src/request.ts
@@ -49,7 +49,7 @@ export type RequestInfoInit = [RequestInfo, RequestInit];
 export type Combinator = <A>(req: Req<A>) => Req<A>;
 
 /**
- * `Resp<A>` is an object that carries the original `Response` from a `fetch()` call and the actual retrieved `data` (of type `A`).
+ * `Resp<A>` is an object that carries the original `Response` from a `fetch()` call, the actual retrieved `data` (of type `A`) and the request's input (optional).
  *
  * @category Response
  * @since 4.0.0
@@ -81,7 +81,7 @@ export interface RequestError {
 }
 
 /**
- * `ResponseError` represents a response error. It carriess the generated `Error` and the original `Response` object.
+ * `ResponseError` represents a response error. It carriess the generated `Error`, the original `Response` object and the request's input (optional).
  *
  * @category Error
  * @since 4.0.0