@varlet/axle 0.0.0 → 0.0.1

package/README.md

@@ -1,9 +1,8 @@
-<div align="center">
+<div>
   <a href="https://github.com/varletjs/axle">
-    <img src="https://github.com/varletjs/axle/blob/main/public/logo.svg" width="200">
+    <img src="https://github.com/varletjs/axle/blob/main/public/logo.svg" width="400">
   </a>
-  <h1>axle</h1>
-  <p>A tool library based on axios to simplify the development process</p>
+  <h2>A tool library based on axios to simplify the development process</h2>
 </div>
 
 ### Quickstart

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/axle",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "A useful axios helper",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -10,15 +10,6 @@
     "helpers"
   ],
   "license": "MIT",
-  "scripts": {
-    "preinstall": "npx only-allow pnpm",
-    "bootstrap": "pnpm i && pnpm --filter ./playground i",
-    "dev": "varlet-cli dev",
-    "build": "varlet-cli build",
-    "preview": "varlet-cli preview",
-    "compile": "rm -rf lib es && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
-    "release": "pnpm compile && varlet-cli release"
-  },
   "devDependencies": {
     "@types/qs": "^6.9.7",
     "@varlet/cli": "^1.26.7",
@@ -51,5 +42,16 @@
   "dependencies": {
     "axios": "^0.26.1",
     "qs": "^6.10.3"
-  }
-}
+  },
+  "scripts": {
+    "preinstall": "npx only-allow pnpm",
+    "bootstrap:ci": "pnpm i",
+    "bootstrap": "pnpm i && pnpm --filter ./playground i",
+    "dev": "varlet-cli dev",
+    "build": "varlet-cli build",
+    "preview": "varlet-cli preview",
+    "compile": "rm -rf lib es && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
+    "release": "pnpm compile && varlet-cli release"
+  },
+  "readme": "<div>\n  <a href=\"https://github.com/varletjs/axle\">\n    <img src=\"https://github.com/varletjs/axle/blob/main/public/logo.svg\" width=\"400\">\n  </a>\n  <h2>A tool library based on axios to simplify the development process</h2>\n</div>\n\n### Quickstart\n\n```shell\n# use npm or yarn or pnpm\n\n# npm\nnpm i @varlet/axle -S\n\n# yarn\nyarn add @varlet/axle\n\n# pnpm\npnpm add @varlet/axle\n```\n\n### Function Signature\n\n```typescript\n// 'get' | 'head' | 'options' | 'delete'\nexport type FetchHelper = <T = any, R = AxiosResponse<T>>(\n  url: string,\n  params?: any,\n  config?: AxiosRequestConfig\n) => Promise<R>\n// 'post' | 'put' | 'patch'\nexport type ModifyHelper = <T = any, R = AxiosResponse<T>>(\n  url: string,\n  data?: any,\n  config?: AxiosRequestConfig\n) => Promise<R>\n\nexport interface AxleHelpers {\n  // get data in json format\n  get: FetchHelper\n  // get data in blob format, which can be used to construct URL download under browser\n  getBlob: FetchHelper\n  // get the html document, return a dom node, can directly embed the document\n  getDocument: FetchHelper\n  // get text\n  getText: FetchHelper\n  // get Arraybuffer, which can be used for segmented download\n  getArraybuffer: FetchHelper\n  // get a readable stream, which can be used for browser caching\n  getStream: FetchHelper\n\n  head: FetchHelper\n  headBlob: FetchHelper\n  headDocument: FetchHelper\n  headText: FetchHelper\n  headArraybuffer: FetchHelper\n  headStream: FetchHelper\n\n  options: FetchHelper\n  optionsBlob: FetchHelper\n  optionsDocument: FetchHelper\n  optionsText: FetchHelper\n  optionsArraybuffer: FetchHelper\n  optionsStream: FetchHelper\n\n  delete: FetchHelper\n  deleteBlob: FetchHelper\n  deleteDocument: FetchHelper\n  deleteText: FetchHelper\n  deleteArrayBuffer: FetchHelper\n  deleteStream: FetchHelper\n\n  // submit application/x-www-form-urlencoded encoded data\n  post: ModifyHelper\n  // submit application/json encoded data\n  postJSON: ModifyHelper\n  // submit multipart/form-data encoded data\n  postMultipart: ModifyHelper\n\n  put: ModifyHelper\n  putJSON: ModifyHelper\n  putMultipart: ModifyHelper\n\n  patch: ModifyHelper\n  patchJSON: ModifyHelper\n  patchMultipart: ModifyHelper\n\n  // browser download file\n  download(blob: string | Blob, filename: string): void\n\n  // set global header\n  setHeader(key: string, value: string): void\n  // remove global header\n  removeHeader(key: string | string[]): void\n}\n```\n\n### Normalize Api Arguments\n\n```js\n// axios\nimport { createAxios } from 'axios'\n\nconst axios = createAxios({})\n\nfunction getUser() {\n  return axios.get('/user', {\n    params: {\n      id: 1,\n    },\n  })\n}\n\nfunction uploadFile() {\n  const formData = new FormData()\n  formData.append('name', 'axios')\n  formData.append('file', new File())\n    \n  return axios.post('/user', formData, {\n    headers: {\n      'Ccontent-Type': 'multipart/form-data',\n    },\n  })\n}\n```\n\n```js\n// axle\nimport { createAxle } from '@varlet/axle'\n\n// create axle instance , axle has the same abilities as axios\nconst axle = createAxle(/** @see http://www.axios-js.com/zh-cn/docs/#axios-create-config **/)\n\n// Some helper functions of axle\nconst axleHelpers = axle.helpers\n\nfunction getUser() {\n  return axleHelpers.get('/user', { id: 1 })\n}\n\nfunction addUser() {\n  return axleHelpers.postMultipart('/user', { name: 'axle', file: new File() })\n}\n```\n"
+}