chore: update type upload (#2743)

pull/2750/head
binhaoCen 2020-08-22 09:14:00 +08:00 committed by GitHub
parent 9eebd8da23
commit e2e0eb32a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 119 additions and 109 deletions

50
types/upload.d.ts vendored
View File

@ -55,25 +55,25 @@ type TransformFileHandler = (
export declare class Upload extends AntdComponent { export declare class Upload extends AntdComponent {
static Dragger: typeof Upload; static Dragger: typeof Upload;
$props: {
/** /**
* File types that can be accepted. * File types that can be accepted.
* @type string * @type string
*/ */
accept: string; accept?: string;
/** /**
* Uploading URL * Uploading URL
* @type string | Function * @type string | Function
*/ */
action: string | Function; action?: string | Function;
/** /**
* support upload whole directory * support upload whole directory
* @type boolean * @type boolean
* @see https://caniuse.com/#feat=input-file-directory * @see https://caniuse.com/#feat=input-file-directory
*/ */
directory: boolean; directory?: boolean;
/** /**
* Hook function which will be executed before uploading. * Hook function which will be executed before uploading.
@ -81,53 +81,55 @@ export declare class Upload extends AntdComponent {
* Warningthis function is not supported in IE9. * Warningthis function is not supported in IE9.
* @type Function * @type Function
*/ */
beforeUpload: (file: any, fileList: any) => boolean | Promise<boolean>; beforeUpload?: (file: any, fileList: UploadFile[]) => boolean | Promise<boolean>;
/** /**
* override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest * override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest
* @type Function * @type Function
*/ */
customRequest: Function; customRequest?: Function;
/** /**
* Uploading params or function which can return uploading params. * Uploading params or function which can return uploading params.
* @type object | Function * @type object | Function
*/ */
data: object | Function; data?: object | Function;
/**
* http method of upload request
*/
method?: 'POST' | 'PUT' | 'post' | 'put'; method?: 'POST' | 'PUT' | 'post' | 'put';
/** /**
* Default list of files that have been uploaded. * Default list of files that have been uploaded.
* @type UploadFile[] * @type UploadFile[]
*/ */
defaultFileList: UploadFile[]; defaultFileList?: UploadFile[];
/** /**
* disable upload button * disable upload button
* @default false * @default false
* @type boolean * @type boolean
*/ */
disabled: boolean; disabled?: boolean;
/** /**
* List of files that have been uploaded (controlled) * List of files that have been uploaded (controlled)
* @type UploadFile[] * @type UploadFile[]
*/ */
fileList: UploadFile[]; fileList?: UploadFile[];
/** /**
* Set request headers, valid above IE10. * Set request headers, valid above IE10.
* @type object * @type object
*/ */
headers: object; headers?: object;
/** /**
* Built-in stylesheets, support for three types: text, picture or picture-card * Built-in stylesheets, support for three types: text, picture or picture-card
* @default 'text' * @default 'text'
* @type string * @type string
*/ */
listType: 'text' | 'picture' | 'picture-card'; listType?: 'text' | 'picture' | 'picture-card';
/** /**
* Whether to support selected multiple file. IE10+ supported. * Whether to support selected multiple file. IE10+ supported.
@ -135,52 +137,60 @@ export declare class Upload extends AntdComponent {
* @default false * @default false
* @type boolean * @type boolean
*/ */
multiple: boolean; multiple?: boolean;
/** /**
* The name of uploading file * The name of uploading file
* @default 'file' * @default 'file'
* @type string * @type string
*/ */
name: string; name?: string;
/** /**
* Whether to show default upload list, could be an object to specify showPreviewIcon and showRemoveIcon individually * Whether to show default upload list, could be an object to specify showPreviewIcon and showRemoveIcon individually
* @default true * @default true
* @type boolean | ShowUploadList * @type boolean | ShowUploadList
*/ */
showUploadList: boolean | ShowUploadList; showUploadList?: boolean | ShowUploadList;
/** /**
* Need to be turned on while the server side is rendering. * Need to be turned on while the server side is rendering.
* @default false * @default false
* @type boolean * @type boolean
*/ */
supportServerRender: boolean; supportServerRender?: boolean;
/** /**
* ajax upload with cookie sent * ajax upload with cookie sent
* @default false * @default false
* @type boolean * @type boolean
*/ */
withCredentials: boolean; withCredentials?: boolean;
/** /**
* click open file dialog * click open file dialog
* @default true * @default true
* @type boolean * @type boolean
*/ */
openFileDialogOnClick: boolean; openFileDialogOnClick?: boolean;
/** /**
* A callback function, will be executed when removing file button is clicked, * A callback function, will be executed when removing file button is clicked,
* remove event will be prevented when return value is false or a Promise which resolve(false) or reject. * remove event will be prevented when return value is false or a Promise which resolve(false) or reject.
* @type Function * @type Function
*/ */
remove: (file: any) => boolean | Promise<boolean>; remove?: (file: any) => boolean | Promise<boolean>;
locale?: UploadLocale; locale?: UploadLocale;
id?: string; id?: string;
/**
* Customize preview file logic (1.5.0)
*/
previewFile?: PreviewFileHandler; previewFile?: PreviewFileHandler;
/**
* Customize transform file before request (1.5.0)
*/
transformFile?: TransformFileHandler; transformFile?: TransformFileHandler;
}
} }