跳转到内容

createRequest / RequestState

接口:RequestState

RequestStatecreateRequest 返回的数据状态类型。

类型声明

typescript
export interface RequestState<
  // 数据
  TData = any,
  // 方法参数
  TParams extends any[] = any[],
  TSerialized = TData,
  // 格式化数据
  TFormatData = TSerialized,
> {
  /**
   * service resolve 的数据,会经过 formatData 处理
   */
  data: Undefinable<TFormatData>

  /**
   * service resolve 的数据
   */
  rawData: Undefinable<TData>

  /**
   * service reject/throw 的错误
   */
  error: Undefinable<any>

  /**
   * service 是否正在执行
   */
  loading: boolean

  /**
   * 请求是否已经完成
   */
  finished: boolean

  /**
   * 当次执行的 service 的参数数组
   */
  params: TParams
}

泛型

名称默认值继承必填描述
TDataany数据类型
TParamsany[]any[]函数入参类型
TSerializedTData序列化后的数据类型
TFormatDataTSerialized格式化数据后的类型

属性

data

  • 必填 - Undefinable<TFormatData>

service resolve 的数据,会经过 formatData 处理

rawData

  • 必填 - Undefinable<TData>

service resolve 的原始数据

error

  • 必填 - Undefinable<any>

service reject/throw 的错误

loading

  • 必填 - boolean
  • 默认值:false

service 是否正在执行

finished

  • 必填 - boolean
  • 默认值:false

请求是否已经完成

params

  • 必填 - TParams

当次执行的 service 的参数数组。比如你触发了 run(1, 2, 3),则 params 等于 [1, 2, 3]