Skip to content

Commit

Permalink
docs: update file interface with field description
Browse files Browse the repository at this point in the history
  • 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.
20 changes: 18 additions & 2 deletions src/backend/utils/uploaded-file.type.ts
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;
}

0 comments on commit e39e5e6

Please sign in to comment.