@axios-use/vue - npm Package Compare versions

Comparing version 0.2.0-alpha.1 to 0.2.0

CHANGELOG.md

@@ -0,1 +1,16 @@
+# [0.2.0](https://github.com/axios-use/axios-use-vue/compare/v0.1.1...v0.2.0) (2023-05-22)
+
+
+### Bug Fixes
+
+* **type:** `onCompleted` response generic error ([3c7e56f](https://github.com/axios-use/axios-use-vue/commit/3c7e56f5737ab34e2dc8706a8f66f29ebce0994f))
+
+
+### Features
+
+* **request:** export `_request` function to custom data or response type ([4ad4896](https://github.com/axios-use/axios-use-vue/commit/4ad4896a11889f29077c339636362f0bf48d83a6), [ec40987](https://github.com/axios-use/axios-use-vue/commit/ec40987447f8f6a3329ef65bfa7ac1ef6abec2cb))
+* **options:** `getResponseItem` options (custom data value)  ([#1](https://github.com/axios-use/axios-use-vue/pull/1))
+
+
+
 ## [0.1.1](https://github.com/axios-use/axios-use-vue/compare/v0.1.0...v0.1.1) (2023-04-15)
@@ -2,0 +17,0 @@

esm/useResource.js

@@ -12,38 +12,2 @@ var __assign = (this && this.__assign) || function () {
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 import { computed, unref, watch } from "vue";
@@ -72,3 +36,2 @@ import { useRequest } from "./useRequest";
 export function useResource(fn, requestParams, options) {
-    var _this = this;
     var _a = useRequest(fn, {
@@ -88,25 +51,14 @@ onCompleted: options === null || options === void 0 ? void 0 : options.onCompleted,
         var _a = createRequest.apply(void 0, args), ready = _a.ready, cancel = _a.cancel;
-        void (function () { return __awaiter(_this, void 0, void 0, function () {
-            var _a, data, response, e_1, error;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _b.trys.push([0, 2, , 3]);
-                        dispatch({ type: "start" });
-                        return [4 /*yield*/, ready()];
-                    case 1:
-                        _a = _b.sent(), data = _a[0], response = _a[1];
-                        dispatch({ type: "success", data: data, response: response });
-                        return [3 /*break*/, 3];
-                    case 2:
-                        e_1 = _b.sent();
-                        error = e_1;
-                        if (!error.isCancel) {
-                            dispatch({ type: "error", error: error });
-                        }
-                        return [3 /*break*/, 3];
-                    case 3: return [2 /*return*/];
-                }
-            });
-        }); })();
+        dispatch({ type: "start" });
+        ready()
+            .then(function (_a) {
+            var data = _a[0], response = _a[1];
+            dispatch({ type: "success", data: data, response: response });
+        })
+            .catch(function (e) {
+            var error = e;
+            if (!error.isCancel) {
+                dispatch({ type: "error", error: error });
+            }
+        });
         return cancel;
@@ -113,0 +65,0 @@ };

lib/useResource.js

@@ -13,38 +13,2 @@ "use strict";
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -75,3 +39,2 @@ exports.useResource = void 0;
 function useResource(fn, requestParams, options) {
-    var _this = this;
     var _a = (0, useRequest_1.useRequest)(fn, {
@@ -91,25 +54,14 @@ onCompleted: options === null || options === void 0 ? void 0 : options.onCompleted,
         var _a = createRequest.apply(void 0, args), ready = _a.ready, cancel = _a.cancel;
-        void (function () { return __awaiter(_this, void 0, void 0, function () {
-            var _a, data, response, e_1, error;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _b.trys.push([0, 2, , 3]);
-                        dispatch({ type: "start" });
-                        return [4 /*yield*/, ready()];
-                    case 1:
-                        _a = _b.sent(), data = _a[0], response = _a[1];
-                        dispatch({ type: "success", data: data, response: response });
-                        return [3 /*break*/, 3];
-                    case 2:
-                        e_1 = _b.sent();
-                        error = e_1;
-                        if (!error.isCancel) {
-                            dispatch({ type: "error", error: error });
-                        }
-                        return [3 /*break*/, 3];
-                    case 3: return [2 /*return*/];
-                }
-            });
-        }); })();
+        dispatch({ type: "start" });
+        ready()
+            .then(function (_a) {
+            var data = _a[0], response = _a[1];
+            dispatch({ type: "success", data: data, response: response });
+        })
+            .catch(function (e) {
+            var error = e;
+            if (!error.isCancel) {
+                dispatch({ type: "error", error: error });
+            }
+        });
         return cancel;
@@ -116,0 +68,0 @@ };

package.json

 {
   "name": "@axios-use/vue",
-  "version": "0.2.0-alpha.1",
+  "version": "0.2.0",
   "description": "A Vue composition utilities for Axios.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -57,5 +57,6 @@ <br>
 
-| config   | type   | default | explain                                                       |
-| -------- | ------ | ------- | ------------------------------------------------------------- |
-| instance | object | `axios` | Axios instance. You can pass your axios with a custom config. |
+| config          | type     | default         | explain                                                                                                               |
+| --------------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------- |
+| instance        | object   | `axios`         | Axios instance. You can pass your axios with a custom config.                                                         |
+| getResponseItem | function | `(r) => r.data` | custom `data` value. The default value is response['data']. [PR#1](https://github.com/axios-use/axios-use-vue/pull/1) |
 
@@ -87,8 +88,9 @@ ```ts
 
-| option              | type            | explain                                          |
-| ------------------- | --------------- | ------------------------------------------------ |
-| fn                  | function        | get AxiosRequestConfig function                  |
-| options.onCompleted | function        | This function is passed the query's result data. |
-| options.onError     | function        | This function is passed an `RequestError` object |
-| options.instance    | `AxiosInstance` | Customize the Axios instance of the current item |
+| option                  | type            | explain                                          |
+| ----------------------- | --------------- | ------------------------------------------------ |
+| fn                      | function        | get AxiosRequestConfig function                  |
+| options.onCompleted     | function        | This function is passed the query's result data. |
+| options.onError         | function        | This function is passed an `RequestError` object |
+| options.instance        | `AxiosInstance` | Customize the Axios instance of the current item |
+| options.getResponseItem | function        | custom returns the value of `data`(index 0).     |
 
@@ -141,11 +143,12 @@ ```ts
 
-| option               | type            | explain                                                             |
-| -------------------- | --------------- | ------------------------------------------------------------------- |
-| fn                   | function        | get AxiosRequestConfig function                                     |
-| parameters           | array \| false  | `fn` function parameters. effect dependency list                    |
-| options.filter       | function        | Request filter. if return a falsy value, will not start the request |
-| options.defaultState | object          | Initialize the state value. `{data, response, error, isLoading}`    |
-| options.onCompleted  | function        | This function is passed the query's result data.                    |
-| options.onError      | function        | This function is passed an `RequestError` object                    |
-| options.instance     | `AxiosInstance` | Customize the Axios instance of the current item                    |
+| option                  | type            | explain                                                             |
+| ----------------------- | --------------- | ------------------------------------------------------------------- |
+| fn                      | function        | get AxiosRequestConfig function                                     |
+| parameters              | array \| false  | `fn` function parameters. effect dependency list                    |
+| options.filter          | function        | Request filter. if return a falsy value, will not start the request |
+| options.defaultState    | object          | Initialize the state value. `{data, response, error, isLoading}`    |
+| options.onCompleted     | function        | This function is passed the query's result data.                    |
+| options.onError         | function        | This function is passed an `RequestError` object                    |
+| options.instance        | `AxiosInstance` | Customize the Axios instance of the current item                    |
+| options.getResponseItem | function        | custom returns the value of `data`(index 0).                        |
 
@@ -308,3 +311,4 @@ ```ts
 unref(reqState).response;
-// MyWrapper<DataType>["data"]. maybe `undefined` type
+// MyWrapper<DataType>["data"]. maybe `undefined` type.
+// You can use `getResponseItem` to customize the value of `data`
 unref(reqState).data;
@@ -311,0 +315,0 @@ ```

No alert changes

Improved metrics

Number of lines in readme file

330

increased by1.23%

Worsened metrics

Total package byte prevSize

54250

decreased by-8.35%

Lines of code

917

decreased by-9.48%

No dependency changes