-
Notifications
You must be signed in to change notification settings - Fork 677
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update file interface with field description
- Loading branch information
Wojciech Krysiak
authored and
Wojciech Krysiak
committed
Sep 4, 2020
1 parent
8132b6d
commit e39e5e6
Showing
1 changed file
with
18 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,27 @@ | ||
/** | ||
* File uploaded via FormData to the backend. | ||
* | ||
* @memberof adminbro | ||
* @memberof AdminBro | ||
* @alias UploadedFile | ||
*/ | ||
export type UploadedFile = { | ||
/** | ||
* The size of the uploaded file in bytes. | ||
* this property says how many bytes of the file have been written to disk yet. | ||
*/ | ||
size: number; | ||
/** | ||
* The path this file is being written to. | ||
*/ | ||
path: string; | ||
|
||
/** | ||
* The mime type of this file, according to the uploading client. | ||
*/ | ||
type: string; | ||
name: string; | ||
|
||
/** | ||
* The name this file had according to the uploading client. | ||
*/ | ||
name: string | null; | ||
} |