fix: change name vueOptionsStateHook to vueOptionsHook

alovajs · Sep 29, 2023 · dc1f0cc · dc1f0cc
1 parent ed7ff45
commit dc1f0cc
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -34,12 +34,12 @@ First use `vueOptionStatesHook` to create an alova instance.
 ```javascript
 import { createAlova, Method } from 'alova';
 import GlobalFetch from 'alova/GlobalFetch';
-import { VueOptionsStateHook } from '@alova/vue-options';
+import { VueOptionsHook } from '@alova/vue-options';
 
 // api.js
 const alovaInst = createAlova({
 	baseURL: 'http://example.com',
-	statesHook: VueOptionsStateHook,
+	statesHook: VueOptionsHook,
 	requestAdapter: GlobalFetch(),
 	responded: response => response.json()
 });

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -34,12 +34,12 @@ yarn add alova @alova/vue-options
 ```javascript
 import { createAlova, Method } from 'alova';
 import GlobalFetch from 'alova/GlobalFetch';
-import { VueOptionsStateHook } from '@alova/vue-options';
+import { VueOptionsHook } from '@alova/vue-options';
 
 // api.js
 const alovaInst = createAlova({
 	baseURL: 'http://example.com',
-	statesHook: VueOptionsStateHook,
+	statesHook: VueOptionsHook,
 	requestAdapter: GlobalFetch(),
 	responded: response => response.json()
 });

diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,2 @@
 export { default as mapAlovaHook } from './mapAlovaHook';
-export { default as VueOptionsStateHook } from './stateHook';
+export { default as VueOptionsHook } from './stateHook';
diff --git a/test/mockData.ts b/test/mockData.ts
@@ -1,6 +1,6 @@
 import { createAlovaMockAdapter, defineMock } from '@alova/mock';
 import { createAlova } from 'alova';
-import { VueOptionsStateHook } from '../src';
+import { VueOptionsHook } from '../src';
 
 const mockData = defineMock({
 	'/unit-test': ({ query }) => ({
@@ -16,7 +16,7 @@ const mockData = defineMock({
 // create a alova instance
 export const alovaInst = createAlova({
 	baseURL: 'http://example.com',
-	statesHook: VueOptionsStateHook,
+	statesHook: VueOptionsHook,
 	localCache: null,
 	requestAdapter: createAlovaMockAdapter([mockData], {
 		delay: 50,

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -36,4 +36,4 @@ interface VueHookMapperMixin<GR extends UseHookCallers> {
 declare function mapAlovaHook<GR extends UseHookCallers>(mapGetter: UseHookMapGetter<GR>): VueHookMapperMixin<GR>[];
 
 /** vue options statesHook */
-declare const VueOptionsStateHook: StatesHook<unknown, unknown>;
+declare const VueOptionsHook: StatesHook<unknown, unknown>;