@varlet/axle 0.0.8 → 0.0.9

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Joker
+Copyright (c) 2022 varlet
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,9 +1,6 @@
-<div>
-  <a href="https://github.com/varletjs/axle">
-    <img src="https://github.com/varletjs/axle/blob/main/public/logo.svg" width="400">
-  </a>
-  <h2>A tool library based on axios to simplify the development process</h2>
-</div>
+### Intro
+
+A tool library based on axios to simplify the development process
 
 ### Quickstart
 
@@ -22,7 +19,7 @@ yarn add @varlet/axle
 pnpm add @varlet/axle
 ```
 
-#### Request call
+#### Request Call
 
 ```js
 import { createAxle } from '@varlet/axle'
@@ -44,11 +41,12 @@ const response = await axle.post('/user', { name: 'Axle' }, { headers: {} })
 import { createAxle } from '@varlet/axle'
 import { createUseAxle } from '@varlet/axle/use'
 
-const axle = createAxle()
-const useAxle = createUseAxle()
+const axle = createAxle(/** @see https://axios-http.com **/)
+const useAxle = createUseAxle(/** @see https://github.com/varletjs/axle/blob/main/src/use.ts?plain=1#L5 **/)
 
 // default immediate request
 const [users, getUsers, loading, { error }] = useAxle({
+  /** @see https://github.com/varletjs/axle/blob/main/src/use.ts?plain=1#L26 **/
   runner: axle.get,
   url: '/user',
   params: { current: 1, pageSize: 10 },

package/es/instance.d.ts

@@ -1,12 +1,12 @@
 import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
-export declare type AxleRequestConfig = AxiosRequestConfig & {
+export type AxleRequestConfig = AxiosRequestConfig & {
     exceptionMessage?: any;
 };
-export declare type FetchHelper = <T = any, R = AxiosResponse<T>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
-export declare type ModifyHelper = <T = any, R = AxiosResponse<T>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
-export declare type FetchMethods = 'get' | 'delete' | 'options' | 'head';
-export declare type ModifyMethods = 'post' | 'put' | 'patch';
-export declare type AxleInstance = {
+export type FetchHelper = <T = any, R = AxiosResponse<T>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
+export type ModifyHelper = <T = any, R = AxiosResponse<T>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
+export type FetchMethods = 'get' | 'delete' | 'options' | 'head';
+export type ModifyMethods = 'post' | 'put' | 'patch';
+export type AxleInstance = {
     get: FetchHelper;
     getBlob: FetchHelper;
     getDocument: FetchHelper;

package/es/use.d.ts

@@ -15,8 +15,8 @@ export interface RunOptions<P> {
     params?: P;
     config?: AxleRequestConfig;
 }
-export declare type RunReturn<D> = Promise<[UnwrapRef<D>, undefined] | [undefined, Error]>;
-export declare type Run<D, P> = (options?: RunOptions<P>) => RunReturn<D>;
+export type RunReturn<D> = Promise<[UnwrapRef<D>, undefined] | [undefined, Error]>;
+export type Run<D, P> = (options?: RunOptions<P>) => RunReturn<D>;
 export interface UseAxleOptions<D, P> {
     runner?: ReturnType<typeof createFetchHelper> | ReturnType<typeof createModifyHelper>;
     url?: string;
@@ -27,6 +27,6 @@ export interface UseAxleOptions<D, P> {
     dataFormatter?(response: any): D;
     errorFormatter?(errorResponse: Error): Error;
 }
-export declare function createUseAxle(options?: CreateUseAxleOptions): <D = any, P = any>(options?: UseAxleOptions<D, P>) => [data: Ref<UnwrapRef<D>>, run: Run<D, P>, loading: Ref<boolean>, extra: {
+export declare function createUseAxle(options?: CreateUseAxleOptions): <D = any, P = any>(options?: UseAxleOptions<D, P>) => [data: Ref<UnwrapRef<D>>, run: Run<D, P>, loading: Ref<UnwrapRef<boolean>>, extra: {
     error: Ref<UnwrapRef<Error | undefined>>;
 }];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/axle",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "A useful axios helper",
   "type": "module",
   "main": "es/index.js",
@@ -26,23 +26,20 @@
     "axios",
     "helpers"
   ],
+  "author": "Joker <13255238145@163.com>",
   "license": "MIT",
+  "dependencies": {
+    "@varlet/shared": "^2.11.8",
+    "axios": "^1.4.0",
+    "qs": "^6.11.0"
+  },
   "devDependencies": {
     "@types/qs": "^6.9.7",
-    "@varlet/cli": "^2.11.1",
-    "@varlet/icons": "^2.11.1",
-    "@varlet/touch-emulator": "^2.11.1",
-    "clipboard": "^2.0.6",
-    "live-server": "^1.2.1",
-    "lodash-es": "^4.17.21",
-    "typescript": "^4.4.4",
-    "vue": "^3.3.1",
-    "vue-router": "^4.2.0"
-  },
-  "peerDependencies": {
-    "vue": "^3.2.0"
+    "@varlet/cli": "^2.11.8",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.1.5",
+    "vue": "^3.3.4"
   },
-  "homepage": "https://varlet.gitee.io/axle/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/varletjs/axle.git"
@@ -50,28 +47,14 @@
   "bugs": {
     "url": "https://github.com/varletjs/axle/issues"
   },
-  "browserslist": [
-    "Chrome >= 51",
-    "iOS >= 10"
-  ],
   "packageManager": "pnpm@8.0.0",
   "engines": {
     "pnpm": ">=8.0"
   },
-  "author": "Joker <13255238145@163.com>",
-  "dependencies": {
-    "@varlet/shared": "^2.11.1",
-    "axios": "^1.4.0",
-    "qs": "^6.11.0"
-  },
   "scripts": {
-    "bootstrap": "pnpm i && pnpm compile && pnpm --filter ./playground i",
-    "bootstrap:ci": "pnpm i",
-    "dev": "varlet-cli dev",
-    "build": "varlet-cli build",
-    "preview": "varlet-cli preview",
-    "compile:watch": "tsc -w",
-    "compile": "tsc",
-    "release": "pnpm compile && varlet-cli release"
+    "bootstrap": "pnpm i && pnpm build && pnpm --filter ./playground i",
+    "dev": "tsc -w",
+    "build": "rimraf ./es && tsc",
+    "release": "pnpm build && varlet-cli release"
   }
 }

package/es/helpers.d.ts

@@ -1,53 +0,0 @@
-import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
-export declare type AxleRequestConfig = AxiosRequestConfig & {
-    exceptionMessage?: any;
-};
-export declare type FetchHelper = <T = any, R = AxiosResponse<T>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
-export declare type ModifyHelper = <T = any, R = AxiosResponse<T>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
-export interface AxiosHelpers {
-    get: FetchHelper;
-    getBlob: FetchHelper;
-    getDocument: FetchHelper;
-    getText: FetchHelper;
-    getArrayBuffer: FetchHelper;
-    getStream: FetchHelper;
-    head: FetchHelper;
-    headBlob: FetchHelper;
-    headDocument: FetchHelper;
-    headText: FetchHelper;
-    headArrayBuffer: FetchHelper;
-    headStream: FetchHelper;
-    options: FetchHelper;
-    optionsBlob: FetchHelper;
-    optionsDocument: FetchHelper;
-    optionsText: FetchHelper;
-    optionsArrayBuffer: FetchHelper;
-    optionsStream: FetchHelper;
-    delete: FetchHelper;
-    deleteBlob: FetchHelper;
-    deleteDocument: FetchHelper;
-    deleteText: FetchHelper;
-    deleteArrayBuffer: FetchHelper;
-    deleteStream: FetchHelper;
-    post: ModifyHelper;
-    postJSON: ModifyHelper;
-    postMultipart: ModifyHelper;
-    put: ModifyHelper;
-    putJSON: ModifyHelper;
-    putMultipart: ModifyHelper;
-    patch: ModifyHelper;
-    patchJSON: ModifyHelper;
-    patchMultipart: ModifyHelper;
-    download(blob: string | Blob, filename: string): void;
-    setHeader(key: string, value: string): void;
-    removeHeader(key: string | string[]): void;
-}
-export declare type FetchMethods = 'get' | 'delete' | 'options' | 'head';
-export declare type ModifyMethods = 'post' | 'put' | 'patch';
-export declare type AxleInstance = AxiosInstance & {
-    helpers: AxiosHelpers;
-};
-export declare function createFetchHelper(service: AxleInstance, method: FetchMethods, responseType: ResponseType): <T, R = AxiosResponse<T, any>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
-export declare function createModifyHelper(service: AxleInstance, method: ModifyMethods, contentType: 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded'): <T, R = AxiosResponse<T, any>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;
-export declare function download(url: string | Blob, filename: string): void;
-export declare function createAxle(config?: AxiosRequestConfig): AxleInstance;

package/es/helpers.js

@@ -1,85 +0,0 @@
-import axios from 'axios';
-import qs from 'qs';
-export function createFetchHelper(service, method, responseType) {
-    return function (url, params, config) {
-        return service[method](url, Object.assign({ params: Object.assign({ _t: Date.now() }, params), responseType }, config));
-    };
-}
-export function createModifyHelper(service, method, contentType) {
-    return function (url, params, config) {
-        if (contentType === 'application/x-www-form-urlencoded') {
-            params = qs.stringify(params);
-        }
-        if (contentType === 'multipart/form-data') {
-            const formData = new FormData();
-            Object.keys(params).forEach((key) => formData.append(key, params[key]));
-            params = formData;
-        }
-        return service[method](url, params, Object.assign({ headers: {
-                'Content-Type': contentType,
-            } }, config));
-    };
-}
-export function download(url, filename) {
-    const a = document.createElement('a');
-    a.download = filename;
-    a.style.display = 'none';
-    a.href = typeof url === 'string' ? url : URL.createObjectURL(url);
-    document.body.appendChild(a);
-    a.click();
-    URL.revokeObjectURL(a.href);
-    document.body.removeChild(a);
-}
-export function createAxle(config = {}) {
-    const service = axios.create(config);
-    function setHeader(key, value) {
-        ;
-        service.defaults.headers['common'][key] = value;
-    }
-    function removeHeader(key) {
-        if (typeof key === 'string') {
-            Reflect.deleteProperty(service.defaults.headers['common'], key);
-            return;
-        }
-        key.forEach((k) => Reflect.deleteProperty(service.defaults.headers['common'], k));
-    }
-    service.helpers = {
-        get: createFetchHelper(service, 'get', 'json'),
-        getBlob: createFetchHelper(service, 'get', 'blob'),
-        getDocument: createFetchHelper(service, 'get', 'document'),
-        getArrayBuffer: createFetchHelper(service, 'get', 'arraybuffer'),
-        getText: createFetchHelper(service, 'get', 'text'),
-        getStream: createFetchHelper(service, 'get', 'stream'),
-        head: createFetchHelper(service, 'head', 'json'),
-        headBlob: createFetchHelper(service, 'head', 'blob'),
-        headDocument: createFetchHelper(service, 'head', 'document'),
-        headArrayBuffer: createFetchHelper(service, 'head', 'arraybuffer'),
-        headText: createFetchHelper(service, 'head', 'text'),
-        headStream: createFetchHelper(service, 'head', 'stream'),
-        options: createFetchHelper(service, 'options', 'json'),
-        optionsBlob: createFetchHelper(service, 'options', 'blob'),
-        optionsDocument: createFetchHelper(service, 'options', 'document'),
-        optionsArrayBuffer: createFetchHelper(service, 'options', 'arraybuffer'),
-        optionsText: createFetchHelper(service, 'options', 'text'),
-        optionsStream: createFetchHelper(service, 'options', 'stream'),
-        delete: createFetchHelper(service, 'delete', 'json'),
-        deleteBlob: createFetchHelper(service, 'delete', 'blob'),
-        deleteDocument: createFetchHelper(service, 'delete', 'document'),
-        deleteArrayBuffer: createFetchHelper(service, 'delete', 'arraybuffer'),
-        deleteText: createFetchHelper(service, 'delete', 'text'),
-        deleteStream: createFetchHelper(service, 'delete', 'stream'),
-        post: createModifyHelper(service, 'post', 'application/x-www-form-urlencoded'),
-        postJSON: createModifyHelper(service, 'post', 'application/json'),
-        postMultipart: createModifyHelper(service, 'post', 'multipart/form-data'),
-        put: createModifyHelper(service, 'put', 'application/x-www-form-urlencoded'),
-        putJSON: createModifyHelper(service, 'put', 'application/json'),
-        putMultipart: createModifyHelper(service, 'put', 'multipart/form-data'),
-        patch: createModifyHelper(service, 'patch', 'application/x-www-form-urlencoded'),
-        patchJSON: createModifyHelper(service, 'patch', 'application/json'),
-        patchMultipart: createModifyHelper(service, 'patch', 'multipart/form-data'),
-        download,
-        setHeader,
-        removeHeader,
-    };
-    return service;
-}

package/es/types.js

@@ -1 +0,0 @@
-"use strict";