upload-content.d.ts 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. import { EpPropFinalized, EpPropMergeType } from "../../../utils/vue/props/types.js";
  2. import { Awaitable, Mutable } from "../../../utils/typescript.js";
  3. import "../../../utils/index.js";
  4. import { UploadAjaxError } from "./ajax.js";
  5. import { UploadBaseProps, UploadData, UploadFile, UploadHooks, UploadProgressEvent, UploadRawFile, UploadRequestHandler, UploadUserFile } from "./upload.js";
  6. import { _default } from "./upload-content.vue.js";
  7. import * as vue from "vue";
  8. import { ExtractPublicPropTypes } from "vue";
  9. //#region ../../packages/components/upload/src/upload-content.d.ts
  10. interface UploadContentProps extends UploadBaseProps {
  11. beforeUpload?: UploadHooks['beforeUpload'];
  12. onRemove?: (file: UploadFile | UploadRawFile) => void;
  13. onStart?: (rawFile: UploadRawFile) => void;
  14. onSuccess?: (response: any, rawFile: UploadRawFile) => unknown;
  15. onProgress?: (evt: UploadProgressEvent, rawFile: UploadRawFile) => void;
  16. onError?: (err: UploadAjaxError, rawFile: UploadRawFile) => void;
  17. onExceed?: UploadHooks['onExceed'];
  18. }
  19. /**
  20. * @deprecated Removed after 3.0.0, Use `UploadContentProps` instead.
  21. */
  22. declare const uploadContentProps: {
  23. readonly beforeUpload: EpPropFinalized<(new (...args: any[]) => (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>) | (() => (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>) | {
  24. (): (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>;
  25. new (): any;
  26. readonly prototype: any;
  27. } | ((new (...args: any[]) => (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>) | (() => (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>) | {
  28. (): (rawFile: UploadRawFile) => Awaitable<void | undefined | null | boolean | File | Blob>;
  29. new (): any;
  30. readonly prototype: any;
  31. })[], unknown, unknown, () => void, boolean>;
  32. readonly onRemove: EpPropFinalized<(new (...args: any[]) => (file: UploadFile | UploadRawFile) => void) | (() => (file: UploadFile | UploadRawFile) => void) | {
  33. (): (file: UploadFile | UploadRawFile) => void;
  34. new (): any;
  35. readonly prototype: any;
  36. } | ((new (...args: any[]) => (file: UploadFile | UploadRawFile) => void) | (() => (file: UploadFile | UploadRawFile) => void) | {
  37. (): (file: UploadFile | UploadRawFile) => void;
  38. new (): any;
  39. readonly prototype: any;
  40. })[], unknown, unknown, () => void, boolean>;
  41. readonly onStart: EpPropFinalized<(new (...args: any[]) => (rawFile: UploadRawFile) => void) | (() => (rawFile: UploadRawFile) => void) | {
  42. (): (rawFile: UploadRawFile) => void;
  43. new (): any;
  44. readonly prototype: any;
  45. } | ((new (...args: any[]) => (rawFile: UploadRawFile) => void) | (() => (rawFile: UploadRawFile) => void) | {
  46. (): (rawFile: UploadRawFile) => void;
  47. new (): any;
  48. readonly prototype: any;
  49. })[], unknown, unknown, () => void, boolean>;
  50. readonly onSuccess: EpPropFinalized<(new (...args: any[]) => (response: any, rawFile: UploadRawFile) => unknown) | (() => (response: any, rawFile: UploadRawFile) => unknown) | {
  51. (): (response: any, rawFile: UploadRawFile) => unknown;
  52. new (): any;
  53. readonly prototype: any;
  54. } | ((new (...args: any[]) => (response: any, rawFile: UploadRawFile) => unknown) | (() => (response: any, rawFile: UploadRawFile) => unknown) | {
  55. (): (response: any, rawFile: UploadRawFile) => unknown;
  56. new (): any;
  57. readonly prototype: any;
  58. })[], unknown, unknown, () => void, boolean>;
  59. readonly onProgress: EpPropFinalized<(new (...args: any[]) => (evt: UploadProgressEvent, rawFile: UploadRawFile) => void) | (() => (evt: UploadProgressEvent, rawFile: UploadRawFile) => void) | {
  60. (): (evt: UploadProgressEvent, rawFile: UploadRawFile) => void;
  61. new (): any;
  62. readonly prototype: any;
  63. } | ((new (...args: any[]) => (evt: UploadProgressEvent, rawFile: UploadRawFile) => void) | (() => (evt: UploadProgressEvent, rawFile: UploadRawFile) => void) | {
  64. (): (evt: UploadProgressEvent, rawFile: UploadRawFile) => void;
  65. new (): any;
  66. readonly prototype: any;
  67. })[], unknown, unknown, () => void, boolean>;
  68. readonly onError: EpPropFinalized<(new (...args: any[]) => (err: UploadAjaxError, rawFile: UploadRawFile) => void) | (() => (err: UploadAjaxError, rawFile: UploadRawFile) => void) | {
  69. (): (err: UploadAjaxError, rawFile: UploadRawFile) => void;
  70. new (): any;
  71. readonly prototype: any;
  72. } | ((new (...args: any[]) => (err: UploadAjaxError, rawFile: UploadRawFile) => void) | (() => (err: UploadAjaxError, rawFile: UploadRawFile) => void) | {
  73. (): (err: UploadAjaxError, rawFile: UploadRawFile) => void;
  74. new (): any;
  75. readonly prototype: any;
  76. })[], unknown, unknown, () => void, boolean>;
  77. readonly onExceed: EpPropFinalized<(new (...args: any[]) => (files: File[], uploadFiles: UploadUserFile[]) => void) | (() => (files: File[], uploadFiles: UploadUserFile[]) => void) | {
  78. (): (files: File[], uploadFiles: UploadUserFile[]) => void;
  79. new (): any;
  80. readonly prototype: any;
  81. } | ((new (...args: any[]) => (files: File[], uploadFiles: UploadUserFile[]) => void) | (() => (files: File[], uploadFiles: UploadUserFile[]) => void) | {
  82. (): (files: File[], uploadFiles: UploadUserFile[]) => void;
  83. new (): any;
  84. readonly prototype: any;
  85. })[], unknown, unknown, () => void, boolean>;
  86. readonly action: EpPropFinalized<StringConstructor, unknown, unknown, "#", boolean>;
  87. readonly headers: {
  88. readonly type: vue.PropType<EpPropMergeType<(new (...args: any[]) => Record<string, any> | Headers) | (() => Record<string, any> | Headers) | ((new (...args: any[]) => Record<string, any> | Headers) | (() => Record<string, any> | Headers))[], unknown, unknown>>;
  89. readonly required: false;
  90. readonly validator: ((val: unknown) => boolean) | undefined;
  91. __epPropKey: true;
  92. };
  93. readonly method: EpPropFinalized<StringConstructor, unknown, unknown, "post", boolean>;
  94. readonly data: EpPropFinalized<(new (...args: any[]) => Mutable<Record<string, any>> | Promise<Mutable<Record<string, any>>> | ((rawFile: UploadRawFile) => Awaitable<UploadData>)) | (() => Awaitable<Mutable<Record<string, any>>> | ((rawFile: UploadRawFile) => Awaitable<UploadData>)) | ((new (...args: any[]) => Mutable<Record<string, any>> | Promise<Mutable<Record<string, any>>> | ((rawFile: UploadRawFile) => Awaitable<UploadData>)) | (() => Awaitable<Mutable<Record<string, any>>> | ((rawFile: UploadRawFile) => Awaitable<UploadData>)))[], unknown, unknown, () => Mutable<{}>, boolean>;
  95. readonly multiple: BooleanConstructor;
  96. readonly name: EpPropFinalized<StringConstructor, unknown, unknown, "file", boolean>;
  97. readonly drag: BooleanConstructor;
  98. readonly withCredentials: BooleanConstructor;
  99. readonly showFileList: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  100. readonly accept: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
  101. readonly fileList: EpPropFinalized<(new (...args: any[]) => UploadUserFile[]) | (() => UploadUserFile[]) | ((new (...args: any[]) => UploadUserFile[]) | (() => UploadUserFile[]))[], unknown, unknown, () => [], boolean>;
  102. readonly autoUpload: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  103. readonly listType: EpPropFinalized<StringConstructor, "text" | "picture" | "picture-card", unknown, "text", boolean>;
  104. readonly httpRequest: EpPropFinalized<(new (...args: any[]) => UploadRequestHandler) | (() => UploadRequestHandler) | {
  105. (): UploadRequestHandler;
  106. new (): any;
  107. readonly prototype: any;
  108. } | ((new (...args: any[]) => UploadRequestHandler) | (() => UploadRequestHandler) | {
  109. (): UploadRequestHandler;
  110. new (): any;
  111. readonly prototype: any;
  112. })[], unknown, unknown, UploadRequestHandler, boolean>;
  113. readonly disabled: EpPropFinalized<BooleanConstructor, unknown, unknown, undefined, boolean>;
  114. readonly limit: NumberConstructor;
  115. readonly directory: BooleanConstructor;
  116. };
  117. /**
  118. * @deprecated Removed after 3.0.0, Use `UploadContentProps` instead.
  119. */
  120. type UploadContentPropsPublic = ExtractPublicPropTypes<typeof uploadContentProps>;
  121. type UploadContentInstance = InstanceType<typeof _default> & unknown;
  122. declare const uploadContentPropsDefaults: {
  123. readonly beforeUpload: () => void;
  124. readonly onRemove: () => void;
  125. readonly onStart: () => void;
  126. readonly onSuccess: () => void;
  127. readonly onProgress: () => void;
  128. readonly onError: () => void;
  129. readonly onExceed: () => void;
  130. readonly action: "#";
  131. readonly method: "post";
  132. readonly data: () => Mutable<{}>;
  133. readonly name: "file";
  134. readonly showFileList: true;
  135. readonly accept: "";
  136. readonly fileList: () => never[];
  137. readonly autoUpload: true;
  138. readonly listType: "text";
  139. readonly httpRequest: UploadRequestHandler;
  140. readonly disabled: undefined;
  141. };
  142. //#endregion
  143. export { UploadContentInstance, UploadContentProps, UploadContentPropsPublic, uploadContentProps, uploadContentPropsDefaults };