cis-api-tool/lib/esm/helpers-DBJO7JLd.d.mts

根据 swagger/yapi/apifox 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。

import { CliHooks, Config, ConfigWithHooks, RequestConfig, RequestFunctionParams } from "./types-B8Xpfzsb.mjs";
import { AppendOptions } from "form-data";

//#region src/helpers.d.ts

/**
 * 定义配置。
 *
 * @param config 配置
 */
declare function defineConfig(config: Config, hooks?: CliHooks): ConfigWithHooks;
declare class FileData<T = any> {
  /**
   * 原始文件数据。
   */
  private originalFileData;
  /**
   * 选项。
   */
  private options;
  /**
   * 文件数据辅助类，统一网页、小程序等平台的文件上传。
   *
   * @param originalFileData 原始文件数据
   * @param options 若使用内部的 getFormData，则选项会被其使用
   */
  constructor(originalFileData: T, options?: AppendOptions);
  /**
   * 获取原始文件数据。
   *
   * @returns 原始文件数据
   */
  getOriginalFileData(): T;
  /**
   * 获取选项。
   */
  getOptions(): AppendOptions | undefined;
}
/**
 * 解析请求数据，从请求数据中分离出普通数据和文件数据。
 *
 * @param requestData 要解析的请求数据
 * @returns 包含普通数据(data)和文件数据(fileData)的对象，data、fileData 为空对象时，表示没有此类数据
 */
declare function parseRequestData(requestData?: any): {
  data: any;
  fileData: any;
};
/**
 * 准备要传给请求函数的参数。
 */
declare function prepare(requestConfig: RequestConfig, requestData: any): RequestFunctionParams;
//#endregion
export { FileData, defineConfig, parseRequestData, prepare };