refactor: optimize types

Author: John60676

src/core/types.ts

@@ -34,6 +34,10 @@ export interface FunctionContext<R, P extends unknown[]> {
   mutate: Mutate<R>;
 }
 
+export interface QueryResult<R, P extends unknown[]>
+  extends State<R, P>,
+    FunctionContext<R, P> {}
+
 interface DebounceOptions {
   leading?: boolean;
   trailing?: boolean;

src/core/useQuery.ts

@@ -6,14 +6,15 @@ import type {
   GlobalOptions,
   Options,
   PluginImplementType,
+  QueryResult,
   Service,
 } from './types';
 
 function useQuery<R, P extends unknown[]>(
   service: Service<R, P>,
   options: Options<R, P> = {},
   plugins: PluginImplementType<R, P>[] = [],
-) {
+): QueryResult<R, P> {
   const injectedGlobalOptions = inject<GlobalOptions>(
     GLOBAL_OPTIONS_PROVIDE_KEY,
     {},

src/usePagination.ts

@@ -1,7 +1,13 @@
+import type { ComputedRef, Ref, WritableComputedRef } from 'vue-demi';
 import { computed, inject, ref } from 'vue-demi';
 
 import { getGlobalOptions, GLOBAL_OPTIONS_PROVIDE_KEY } from './core/config';
-import type { GlobalOptions, Options, Service } from './core/types';
+import type {
+  GlobalOptions,
+  Options,
+  QueryResult,
+  Service,
+} from './core/types';
 import { get } from './core/utils';
 import { merge } from './core/utils/lodash';
 import useRequest from './useRequest';
@@ -19,10 +25,23 @@ export interface PaginationOptions<R, P extends unknown[]>
   extends Options<R, P>,
     PaginationExtendsOption {}
 
+interface PaginationQueryResult<R, P extends unknown[]>
+  extends QueryResult<R, P> {
+  current: WritableComputedRef<number>;
+  pageSize: WritableComputedRef<number>;
+  total: ComputedRef<number>;
+  totalPage: ComputedRef<number>;
+  reloading: Ref<boolean>;
+  reload: () => void;
+  changeCurrent: (current: number) => void;
+  changePageSize: (pageSize: number) => void;
+  changePagination: (current: number, pageSize: number) => void;
+}
+
 function usePagination<R, P extends unknown[] = any>(
   service: Service<R, P>,
   options?: PaginationOptions<R, P>,
-) {
+): PaginationQueryResult<R, P> {
   const defaultOptions = {
     pagination: {
       currentKey: 'current',

src/useRequest.ts

@@ -7,13 +7,13 @@ import useReadyPlugin from './core/plugins/useReadyPlugin';
 import useRefreshDepsPlugin from './core/plugins/useRefreshDepsPlugin';
 import useRefreshOnWindowFocus from './core/plugins/useRefreshOnWindowFocus';
 import useThrottlePlugin from './core/plugins/useThrottlePlugin';
-import type { Options, Service } from './core/types';
+import type { Options, QueryResult, Service } from './core/types';
 import useQuery from './core/useQuery';
 
 function useRequest<R, P extends unknown[] = any>(
   service: Service<R, P>,
   options?: Options<R, P>,
-) {
+): QueryResult<R, P> {
   return useQuery<R, P>(service, options, [
     useLoadingDelayPlugin,
     useErrorRetryPlugin,