chore: clean

varletjs · Jul 7, 2023 · 1f36fde · 1f36fde
1 parent 585c49a
commit 1f36fde
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ### Intro
 
-A tool library based on axios to simplify the development process
+Progressive request tool based on axios.
 
 ### Quickstart
 
@@ -30,8 +30,16 @@ const axle = createAxle(/** @see https://axios-http.com **/)
 // The built-in axios of the axle, the usage is exactly the same as that of axios, and shares the configuration with the axle.
 const { axios } = axle
 
-const response = await axle.get('/user', { current: 1, pageSize: 10 }, { headers: {} })
-const response = await axle.post('/user', { name: 'Axle' }, { headers: {} })
+axios.interceptors.response.use(
+  response => response,
+  error => Promise.reject(error)
+)
+
+const response = await axle.get('/url', { current: 1, pageSize: 10 }, { headers: {} })
+const response = await axle.post('/url', { name: 'Axle' }, { headers: {} })
+const response = await axle.getBlob('/url')
+const response = await axle.postJSON('/url', { name: 'Axle' }, { headers: {} })
+const response = await axle.postMultipart('/url', { name: 'Axle', file: new File() })
 ```
 
 ### Vue Composition Api
@@ -42,11 +50,9 @@ import { createAxle } from '@varlet/axle'
 import { createUseAxle } from '@varlet/axle/use'
 
 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 **/)
+const useAxle = createUseAxle(/** Unstable **/)
 
-// default immediate request
-const [users, getUsers, loading, { error }] = useAxle({
-  /** @see https://github.com/varletjs/axle/blob/main/src/use.ts?plain=1#L26 **/
+const [users, getUsers, { loading, error }] = useAxle({
   runner: axle.get,
   url: '/user',
   params: { current: 1, pageSize: 10 },

diff --git a/playground/src/App.vue b/playground/src/App.vue
@@ -1,22 +1,22 @@
 <script setup lang="ts">
 import {
-  useApiGetUser,
-  useApiGetUsers,
-  useApiAddUser,
-  useApiDeleteUser,
-  useApiUpdateUser,
-  useApiPatchUser,
-  useApiDownloadFile,
-  useApiThrowError,
+  useGetUser,
+  useGetUsers,
+  useAddUser,
+  useDeleteUser,
+  useUpdateUser,
+  usePatchUser,
+  useDownloadFile,
+  useThrowError,
   User,
 } from './apis'
 
 const id = ref('1')
 const deleteId = ref('1')
 
-const [users, apiGetUsers, { loading: isUsersLoading }] = useApiGetUsers<User[]>([], { immediate: true })
+const [users, getUsers, { loading: isUsersLoading }] = useGetUsers<User[]>([], { immediate: true })
 
-const [user, apiGetUser, { loading: isUserLoading, abort }] = useApiGetUser<User>(
+const [user, getUser, { loading: isUserLoading, abort }] = useGetUser<User>(
   {},
   {
     onSuccess(response) {
@@ -27,7 +27,7 @@ const [user, apiGetUser, { loading: isUserLoading, abort }] = useApiGetUser<User
   }
 )
 
-const [addedUser, apiAddUser] = useApiAddUser<User>(
+const [addedUser, addUser] = useAddUser<User>(
   {},
   {
     onBefore() {
@@ -41,7 +41,7 @@ const [addedUser, apiAddUser] = useApiAddUser<User>(
   }
 )
 
-const [updatedUser, apiUpdateUser] = useApiUpdateUser<User>(
+const [updatedUser, updateUser] = useUpdateUser<User>(
   {},
   {
     onBefore() {
@@ -55,7 +55,7 @@ const [updatedUser, apiUpdateUser] = useApiUpdateUser<User>(
   }
 )
 
-const [patchedUser] = useApiPatchUser<User>(
+const [patchedUser] = usePatchUser<User>(
   {},
   {
     onBefore() {
@@ -69,7 +69,7 @@ const [patchedUser] = useApiPatchUser<User>(
   }
 )
 
-const [deletedUser, apiDeleteUser] = useApiDeleteUser<User>(
+const [deletedUser, deleteUser] = useDeleteUser<User>(
   {},
   {
     onBefore() {
@@ -83,11 +83,11 @@ const [deletedUser, apiDeleteUser] = useApiDeleteUser<User>(
   }
 )
 
-const [file, apiDownloadFile, { downloadProgress }] = useApiDownloadFile<Blob | null>(null, {
+const [file, downloadFile, { downloadProgress }] = useDownloadFile<Blob | null>(null, {
   onTransform: (response) => response,
 })
 
-const [errorUser, apiThrowError, { loading: isThrowErrorLoading }] = useApiThrowError(
+const [errorUser, throwError, { loading: isThrowErrorLoading }] = useThrowError(
   {},
   {
     onBefore(refs) {
@@ -104,16 +104,16 @@ const userRecord = reactive<User>({
 
 async function handleSubmit() {
   const options = { params: user }
-  userRecord.id ? await apiUpdateUser(options) : await apiAddUser(options)
+  userRecord.id ? await updateUser(options) : await addUser(options)
 }
 
 async function handleDelete() {
-  await apiDeleteUser({ params: { id: deleteId.value } })
+  await deleteUser({ params: { id: deleteId.value } })
 }
 
 watch(
   () => [addedUser.value, updatedUser.value, deletedUser.value, patchedUser.value],
-  () => apiGetUsers()
+  () => getUsers()
 )
 </script>
 
@@ -129,7 +129,7 @@ watch(
   <var-space direction="column">
     <var-space align="center">
       <var-input type="number" variant="outlined" v-model="id" />
-      <var-button type="primary" @click="apiGetUser({ params: { id } })">Search</var-button>
+      <var-button type="primary" @click="getUser({ params: { id } })">Search</var-button>
       <var-button type="warning" @click="abort">Abort</var-button>
     </var-space>
 
@@ -162,7 +162,7 @@ watch(
   <var-space direction="column">
     <h3>Download Progress: {{ downloadProgress * 100 }} %</h3>
     <h3>File Size: {{ file?.size ?? 0 }}</h3>
-    <var-button type="primary" @click="() => apiDownloadFile()">Download (PS: Please use slow 3G)</var-button>
+    <var-button type="primary" @click="() => downloadFile()">Download (PS: Please use slow 3G)</var-button>
   </var-space>
 
   <var-divider margin="30px 0" />
@@ -171,6 +171,6 @@ watch(
     <var-cell>name: throw error</var-cell>
     <var-cell>loading: {{ isThrowErrorLoading }}</var-cell>
     <var-cell>data: {{ errorUser ?? 'No Data' }}</var-cell>
-    <var-button type="primary" @click="() => apiThrowError()">Retry</var-button>
+    <var-button type="primary" @click="() => throwError()">Retry</var-button>
   </var-space>
 </template>
diff --git a/playground/src/apis/index.ts b/playground/src/apis/index.ts
@@ -14,7 +14,7 @@ export interface User {
 
 export type Options<D, R = any, P = Record<string, any>> = Partial<Omit<UseAxleOptions<D, R, P>, 'data'>>
 
-export function useApiGetUsers<D>(data: D, options?: Options<D, Response<User[]>>) {
+export function useGetUsers<D>(data: D, options?: Options<D, Response<User[]>>) {
   return useAxle({
     data,
     url: '/user/list-user',
@@ -23,7 +23,7 @@ export function useApiGetUsers<D>(data: D, options?: Options<D, Response<User[]>
   })
 }
 
-export function useApiGetUser<D>(data: D, options?: Options<D, Response<User>>) {
+export function useGetUser<D>(data: D, options?: Options<D, Response<User>>) {
   return useAxle({
     data,
     url: '/user/get-user',
@@ -32,7 +32,7 @@ export function useApiGetUser<D>(data: D, options?: Options<D, Response<User>>)
   })
 }
 
-export function useApiAddUser<D>(data: D, options?: Options<D, Response<User>>) {
+export function useAddUser<D>(data: D, options?: Options<D, Response<User>>) {
   return useAxle({
     data,
     url: '/user/add-user',
@@ -41,7 +41,7 @@ export function useApiAddUser<D>(data: D, options?: Options<D, Response<User>>)
   })
 }
 
-export function useApiDeleteUser<D>(data: D, options?: Options<D, Response<User>>) {
+export function useDeleteUser<D>(data: D, options?: Options<D, Response<User>>) {
   return useAxle({
     data,
     url: '/user/delete-user',
@@ -50,7 +50,7 @@ export function useApiDeleteUser<D>(data: D, options?: Options<D, Response<User>
   })
 }
 
-export function useApiUpdateUser<D>(data: D, options?: Options<D, Response<User>>) {
+export function useUpdateUser<D>(data: D, options?: Options<D, Response<User>>) {
   return useAxle({
     data,
     url: '/user/update-user',
@@ -59,7 +59,7 @@ export function useApiUpdateUser<D>(data: D, options?: Options<D, Response<User>
   })
 }
 
-export function useApiPatchUser<D>(data: D, options?: Options<D, Response<User>>) {
+export function usePatchUser<D>(data: D, options?: Options<D, Response<User>>) {
   return useAxle({
     data,
     url: '/user/patch-user',
@@ -68,7 +68,7 @@ export function useApiPatchUser<D>(data: D, options?: Options<D, Response<User>>
   })
 }
 
-export function useApiDownloadFile<D>(data: D, options?: Options<D, Blob>) {
+export function useDownloadFile<D>(data: D, options?: Options<D, Blob>) {
   return useAxle({
     data,
     url: 'http://localhost:5173/logo.png',
@@ -77,7 +77,7 @@ export function useApiDownloadFile<D>(data: D, options?: Options<D, Blob>) {
   })
 }
 
-export function useApiThrowError<D>(data: D, options?: Options<D, Response<User>>) {
+export function useThrowError<D>(data: D, options?: Options<D, Response<User>>) {
   return useAxle({
     data,
     url: '/user/throw-error',