api.d.ts 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. import * as utils from './utils';
  2. import { Config, UploadInfo } from './upload';
  3. interface UpHosts {
  4. data: {
  5. up: {
  6. acc: {
  7. main: string[];
  8. };
  9. };
  10. };
  11. }
  12. export declare function getUpHosts(token: string, protocol: 'https:' | 'http:'): Promise<UpHosts>;
  13. export declare type UploadUrlConfig = Partial<Pick<Config, 'upprotocol' | 'uphost' | 'region' | 'useCdnDomain'>>;
  14. /** 获取上传url */
  15. export declare function getUploadUrl(config: UploadUrlConfig, token: string): Promise<string>;
  16. export interface InitPartsData {
  17. /** 该文件的上传 id, 后续该文件其他各个块的上传,已上传块的废弃,已上传块的合成文件,都需要该 id */
  18. uploadId: string;
  19. /** uploadId 的过期时间 */
  20. expireAt: number;
  21. }
  22. /**
  23. * @param token 上传鉴权凭证
  24. * @param bucket 上传空间
  25. * @param key 目标文件名
  26. * @param uploadUrl 上传地址
  27. */
  28. export declare function initUploadParts(token: string, bucket: string, key: string | null | undefined, uploadUrl: string): utils.Response<InitPartsData>;
  29. export interface UploadChunkData {
  30. etag: string;
  31. md5: string;
  32. }
  33. /**
  34. * @param token 上传鉴权凭证
  35. * @param index 当前 chunk 的索引
  36. * @param uploadInfo 上传信息
  37. * @param options 请求参数
  38. */
  39. export declare function uploadChunk(token: string, key: string | null | undefined, index: number, uploadInfo: UploadInfo, options: Partial<utils.RequestOptions>): utils.Response<UploadChunkData>;
  40. export declare type UploadCompleteData = any;
  41. /**
  42. * @param token 上传鉴权凭证
  43. * @param key 目标文件名
  44. * @param uploadInfo 上传信息
  45. * @param options 请求参数
  46. */
  47. export declare function uploadComplete(token: string, key: string | null | undefined, uploadInfo: UploadInfo, options: Partial<utils.RequestOptions>): utils.Response<UploadCompleteData>;
  48. /**
  49. * @param token 上传鉴权凭证
  50. * @param key 目标文件名
  51. * @param uploadInfo 上传信息
  52. */
  53. export declare function deleteUploadedChunks(token: string, key: string | null | undefined, uploadinfo: UploadInfo): utils.Response<void>;
  54. export {};