add documentation

pikax · Apr 20, 2020 · 04fcb83 · 04fcb83
1 parent 43f78d4
commit 04fcb83
Show file tree

Hide file tree

Showing 4 changed files with 168 additions and 479 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -207,7 +207,10 @@ module.exports = {
           title: "External",
           sidebarDepth: 1,
           collapsable: false,
-          children: [["composable/external/axios", "axios"]]
+          children: [
+            ["composable/external/axios", "axios"],
+            ["composable/external/makeAxios", "makeAxios"]
+          ]
         }
       ]
     },

diff --git a/docs/api/axios.api.md b/docs/api/axios.api.md
@@ -6,27 +6,29 @@
 import { AxiosInstance } from "axios";
 import { AxiosRequestConfig } from "axios";
 import { AxiosResponse } from "axios";
-import { ComputedRef } from "@vue/runtime-core";
 import { PromiseResultFactory } from "vue-composable";
-import { Ref } from "@vue/runtime-core";
+import { Ref } from "@vue/composition-api";
 
 // @public (undocumented)
 export function makeAxios(
   client: AxiosInstance,
   throwException?: boolean
 ): {
   client: AxiosInstance;
-  data: import("@vue/reactivity").ComputedRef<any>;
-  status: import("@vue/reactivity").ComputedRef<number>;
-  statusText: import("@vue/reactivity").ComputedRef<string>;
+  data: Readonly<
+    import("@vue/composition-api/dist/reactivity/ref").Ref<Readonly<any>>
+  >;
+  status: Readonly<
+    import("@vue/composition-api/dist/reactivity/ref").Ref<number>
+  >;
+  statusText: Readonly<
+    import("@vue/composition-api/dist/reactivity/ref").Ref<string>
+  >;
   cancel: (message?: string | undefined) => void;
-  isCancelled:
-    | import("@vue/reactivity").Ref<false>
-    | import("@vue/reactivity").Ref<true>;
-  cancelledMessage:
-    | import("@vue/reactivity").Ref<undefined>
-    | import("@vue/reactivity").Ref<null>
-    | import("@vue/reactivity").Ref<string>;
+  isCancelled: import("@vue/composition-api/dist/reactivity/ref").Ref<boolean>;
+  cancelledMessage: import("@vue/composition-api/dist/reactivity/ref").Ref<
+    string | null | undefined
+  >;
   exec: (
     request: string | AxiosRequestConfig
   ) => Promise<AxiosResponse<any> | undefined>;