@swan-io/request - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/Request.d.ts

@@ -34,3 +34,3 @@ import { Future, Option, Result } from "@swan-io/boxed";
 };
-type Response<T> = {
+export type Response<T> = {
     status: number;
@@ -37,0 +37,0 @@ ok: boolean;

HISTORY.md

@@ -0,4 +1,9 @@
+# 1.0.1
 
+## Changes
+
+- Expose `Response` type
+
 # 1.0.0
 
 Initial version

package.json

 {
   "name": "@swan-io/request",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Wrapper for XMLHttpRequest with better data-structures",
@@ -5,0 +5,0 @@ "main": "dist/Request.js",

README.md

@@ -91,7 +91,18 @@ <img width="108" alt="@swan-io/request logo" src="https://github.com/swan-io/request/blob/main/logo.svg?raw=true">
 
-#### emptyToError
+#### Return value
 
+Returns a `Future<Result<Response<T>, NetworkError | TimeoutError>>`, where `Response<T>` has the following properties:
+
+- `status`: `number`
+- `ok`: `boolean`
+- `response`: `Option<T>`
+- `xhr`: `XMLHttpRequest`
+
+`T` is the type associated with the `responseType` provided in the `config` object.
+
+### emptyToError
+
 Helper to use with `mapOkToResult` to consider empty response as an error.
 
-#### badStatusToError
+### badStatusToError
 
@@ -98,0 +109,0 @@ Helper to use with `mapOkToResult` to consider a status outside of the 200-299 range as an error.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27831

increased by1.39%

Number of lines in readme file

111

increased by11%

No dependency changes