记录一些TS类型体操

1
2

export type PromiseReturnType<T extends (...args: any) => any> =
    ReturnType<T> extends Promise<infer R> ? R : ReturnType<T>

1
2
3
4
5
6
7
8

type PromiseData = ()=>Promise<{
  a: number
  b: string
}>

type Foo = PromiseReturnType<PromiseData>

// Foo = { a: number, b:string }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

// 响应结构
interface GlobalResponse<T> {
  code: StatusCode
  msg: string
  data: T
}

// 拿到 GlobalResponse 中的T的类型
type ApiResponseReturnType<T> = T extends GlobalResponse<infer U> ? U : never

// example
type Foo = GlobalResponse<{
  foo: string
  bar: string
}>

type Bar = ApiResponseReturnType<Foo>
// Bar = {foo: string, bar: string}

1
2
3
4
5
6
7
8

type NestedKeyOf<ObjectType extends object> = {
  [Key in keyof ObjectType &
    (string | number)]: ObjectType[Key] extends unknown[]
    ? `${Key}`
    : ObjectType[Key] extends object
    ? `${Key}` | `${Key}.${NestedKeyOf<ObjectType[Key]>}`
    : `${Key}`
}[keyof ObjectType & (string | number)]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

// 全局响应结构
interface GlobalResponse<T> {
  code: StatusCode
  msg: string
  data: T
}

// 使用GlobalResponse重新组成返回类型
export type UseHttpDataSource<T extends AnyFun> = GlobalResponse<
    ApiResponseReturnType<PromiseReturnType<T>>
    >

// 拿到 GlobalResponse 中的T的类型
export type ApiResponseReturnType<T> = T extends GlobalResponse<infer U> ? U : never

// 提取函数返回数据的对象路径联合类型
export type UseHttpDataSourceKeys<T extends AnyFun> = NestedKeyOf<
    UseHttpDataSource<T>
    >
// 对axios的封装，这里不展示
const getData = (params: { name: string }) =>
  request.get<{
    data: {
      list: string[]
    }
  }>('/api/example', params)


// useHttp内部对dataSourceKey定义为UseHttpDataSourceKeys
const {
  run,
  data, // 经过dataSourceKey的处理，返回结果为string[]
  loading
} = useHttp(getData, {
  defaultParams: [{ name: '' }],
  dataSourceKey: 'data.list', // 传入路径，在自己封装的useHttp中根据路径拿到数据
  debounceInterval: 300
})

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

import { Ref, ref } from 'vue'
import {
  PromiseReturnType,
  YxResponse,
  YxResponseReturnType
} from '@/types/app'
import { useRequest, Options } from 'vue-request'
import { otherUtil } from '@/utils'
export type UseHttpDataSourceKeys<T extends AnyFun> = NestedKeyOf<
  UseHttpDataSource<T>
>
export type UseHttpDataSource<T extends AnyFun> = YxResponse<
  YxResponseReturnType<PromiseReturnType<T>>
>
export type UseHttpDataType<T extends AnyFun, K extends string> = TypeFromPath<
  UseHttpDataSource<T>,
  K
>
export type UseHttpServiceParams<T extends AnyFun> = Parameters<T>
type RequestOptions<
  T extends AnyFun,
  K extends string,
  D extends unknown[]
> = Omit<
  Options<UseHttpDataType<T, K>, D>,
  | 'onSuccess'
  | 'onBefore'
  | 'manual'
  | 'onError'
  | 'onAfter'
  | 'initialData'
  | 'ready'
>
export type UseHttpOptions<
  T extends AnyFun,
  K extends string,
  D extends UseHttpServiceParams<T>,
  C extends any[]
> = RequestOptions<T, K, D> & {
  manual?: boolean
  dataSourceKey?: K & UseHttpDataSourceKeys<T>
  onBefore?: (
    ...params: ArrayConcat<D, C>
  ) =>
    | [...UseHttpServiceParams<T>]
    | boolean
    | undefined
    | void
    | Promise<[...UseHttpServiceParams<T>] | boolean>
  onSuccess?: (
    data: Ref<UseHttpDataType<T, K>>,
    params: ArrayConcat<D, C>
  ) => void
  onError?: (error: YxResponse<any>, ...params: ArrayConcat<D, C>) => void
  onAfter?: (...params: ArrayConcat<D, C>) => void
  onControl?: (params: D, ...controls: C) => [...UseHttpServiceParams<T>]
  initialData?: Partial<UseHttpDataType<T, K>>
}

type RequestReturnType = ReturnType<typeof useRequest>

export type UseHttpReturn<
  T extends AnyFun,
  K extends string,
  D extends unknown[],
  C extends any[]
> = {
  runAsync: (...params: D) => Promise<UseHttpDataSource<T>>
  run: (...params: D) => void
  loading: RequestReturnType['loading']
  error: RequestReturnType['error']
  data: Ref<UseHttpDataType<T, K>>
  params: Ref<never[] | D>
  refresh: () => void
  refreshAsync: () => Promise<UseHttpDataSource<T>>
  runWithControl: (...controls: C) => void
  runWithControlAsync: () => Promise<UseHttpDataSource<T>>
}
function useHttp<
  T extends AnyFun,
  K extends UseHttpDataSourceKeys<T>,
  D extends UseHttpServiceParams<T>,
  C extends any[]
>(fun: T, options?: UseHttpOptions<T, K, D, C>): UseHttpReturn<T, K, D, C> {
  const data = ref(options?.initialData || {}) as unknown as Ref<
    UseHttpDataType<T, K>
  >
  options = {
    ...options
  }

  const requestOptions: Record<string, any> = {
    refreshDepsAction: () => {
      run(...params.value)
    }
  }
  const keys = [
    'onSuccess',
    'onBefore',
    'manual',
    'onError',
    'onAfter',
    'initialData',
    'ready'
  ]
  const optionKeys = Object.keys(options || {}) as Array<
    keyof RequestOptions<T, K, D>
  >
  optionKeys.forEach((item) => {
    if (!keys.includes(item)) {
      if (options) {
        requestOptions[item] = options[item]
      }
    }
  })
  const currentCreateQuery = ref([]) as unknown as Ref<C>
  const {
    runAsync: rAsync,
    loading,
    params,
    error
  } = useRequest(fun, {
    ...requestOptions,
    defaultParams: options?.defaultParams,
    manual: true,
    onSuccess(res) {
      let result = (res || {}) as UseHttpDataSource<T> & Record<string, any>
      if (options?.dataSourceKey) {
        const dataSourceKey = (options?.dataSourceKey || '').split('.') || []
        dataSourceKey.forEach((item) => {
          result = result[item]
        })
      }
      data.value = result as UseHttpDataType<T, K>
      if (options?.onSuccess) {
        options.onSuccess(data, [...params.value, ...currentCreateQuery.value])
      }
    },
    onError(error) {
      const err = error as unknown as YxResponse<any>
      if (options?.onError) {
        options.onError(err, ...params.value, ...currentCreateQuery.value)
      }
    },
    onAfter() {
      if (options?.onAfter) {
        options.onAfter(...params.value, ...currentCreateQuery.value)
      }
    }
  })
  const beforeCallBack = ():
    | [...UseHttpServiceParams<T>]
    | boolean
    | undefined
    | Promise<[...UseHttpServiceParams<T>] | boolean>
    | void => {
    if (options?.onBefore) {
      return options.onBefore(...params.value, ...currentCreateQuery.value)
    } else {
      return true
    }
  }
  const runAsync = (...query: D): any => {
    if (loading.value) {
      return
    }
    const onBeforeResult = beforeCallBack()
    const resType = otherUtil.getPrototypeType(onBeforeResult)
    if (resType === 'Promise') {
      ;(onBeforeResult as Promise<[...UseHttpServiceParams<T>] | boolean>).then(
        (res) => {
          const type = typeof res
          if (type === 'boolean' && !onBeforeResult) {
            return
          }
          if (Array.isArray(res)) {
            query = res
          }
          return rAsync(...(query || params.value))
        }
      )
      return
    }
    if (resType === 'Boolean' && !onBeforeResult) {
      return
    }
    if (resType === 'Array') {
      query = onBeforeResult as D
    }
    return rAsync(...(query || params.value))
  }
  const run = (...query: D): void => {
    runAsync(...query)
  }
  if (!options?.manual) {
    run(...params.value)
  }
  const refresh = () => {
    run(...params.value)
  }
  const refreshAsync = () => {
    return runAsync(...params.value)
  }

  const runWithControl = (...controls: C) => {
    currentCreateQuery.value = controls
    let query = params.value
    if (options?.onControl) {
      query = options.onControl(params.value, ...controls)
      params.value = query
    }
    run(...query)
  }

  const runWithControlAsync = (...controls: C) => {
    let query = params.value
    currentCreateQuery.value = controls
    if (options?.onControl) {
      query = options.onControl(params.value, ...controls)
      params.value = query
    }
    return runAsync(...query)
  }

  return {
    run,
    loading,
    runAsync,
    data,
    params,
    error,
    refresh,
    refreshAsync,
    runWithControl,
    runWithControlAsync
  }
}

export default useHttp