[BUILD]: make version 5.0.0

Author: JinSSJ3

build/index.d.ts

@@ -1,12 +1,12 @@
-import { createPDF, createWord, createListOfMultiTypeFile } from "./utils/files.utils";
+import { createPDF, createWord, createListOfMultiTypeFile, createSyntheticFile } from "./utils/files.utils";
 import { makeSynthticFileValidate } from "./components/dropzone/components/utils/validation.utils";
-import { UploadPromiseAxiosResponse, FileDuiResponse, DropzoneUIResponse } from "./components/dropzone/components/utils/dropzone-ui.upload.utils";
-import { FileValidated, UPLOADSTATUS } from "./components/dropzone/components/utils/validation.utils";
-export declare type UploadPromiseAxiosResponseType = UploadPromiseAxiosResponse;
-export declare type FileDuiResponseType = FileDuiResponse;
-export declare type DropzoneUIResponseType = DropzoneUIResponse;
-export declare type FileValidatedType = FileValidated;
-export { createPDF, createWord, createListOfMultiTypeFile, makeSynthticFileValidate, UPLOADSTATUS };
+import { UploadPromiseAxiosResponse as UploadPromiseAxiosResponseType, FileDuiResponse as FileDuiResponseType, DropzoneUIResponse as DropzoneUIResponseType } from "./components/dropzone/components/utils/dropzone-ui.upload.utils";
+import { FileValidated as FileValidatedType, UPLOADSTATUS } from "./components/dropzone/components/utils/validation.utils";
+export declare type UploadPromiseAxiosResponse = UploadPromiseAxiosResponseType;
+export declare type FileDuiResponse = FileDuiResponseType;
+export declare type DropzoneUIResponse = DropzoneUIResponseType;
+export declare type FileValidated = FileValidatedType;
+export { createPDF, createWord, createListOfMultiTypeFile, createSyntheticFile, makeSynthticFileValidate, UPLOADSTATUS };
 export { default as Dropzone } from "./components/dropzone/components/Dropzone/Dropzone";
 export * from "./components/dropzone/components/Dropzone/Dropzone";
 export { default as DropzoneLabel } from "./components/dropzone/components/DropzoneLabel/DropzoneLabel";

build/index.es.js

@@ -1,3 +1,31 @@
+/**
+ * Creates a synthetic pdf File object instance
+ * @param name
+ * @param size
+ * @param type
+ * @returns
+ */
 export declare const createPDF: (name?: string, size?: number, type?: string) => File;
+/**
+ * Creates a synthetic word File object instance
+ * @param name
+ * @param size
+ * @param type
+ * @returns
+ */
 export declare const createWord: (name?: string, size?: number, type?: string) => File;
+/**
+ * Create a list of synthetic files with different mime types
+ * @param size the file size for each synthetic file
+ * @returns a list of synthetic file
+ */
 export declare const createListOfMultiTypeFile: (size?: number) => File[];
+/**
+ * Creates a synthetic file.
+ * By default, creates a png image file
+ * @param name the file name to show. By default is set to "png-image-file-with-large-name.png"
+ * @param size the size in bytes of the file. By default this value is set to 455555
+ * @param type the mime type of the file. By default is set to "image/png"
+ * @returns
+ */
+export declare const createSyntheticFile: (name?: string, size?: number, type?: string) => File;

build/index.es.js.map

@@ -1,13 +1,13 @@
-import { createPDF, createWord, createListOfMultiTypeFile } from "./utils/files.utils";
+import { createPDF, createWord, createListOfMultiTypeFile, createSyntheticFile } from "./utils/files.utils";
 import { makeSynthticFileValidate } from "./components/dropzone/components/utils/validation.utils";
 
-import { UploadPromiseAxiosResponse, FileDuiResponse, DropzoneUIResponse } from "./components/dropzone/components/utils/dropzone-ui.upload.utils";
-import { FileValidated, UPLOADSTATUS } from "./components/dropzone/components/utils/validation.utils";
-export type UploadPromiseAxiosResponseType = UploadPromiseAxiosResponse;
-export type FileDuiResponseType = FileDuiResponse;
-export type DropzoneUIResponseType = DropzoneUIResponse;
-export type FileValidatedType = FileValidated;
-export { createPDF, createWord, createListOfMultiTypeFile, makeSynthticFileValidate, UPLOADSTATUS };
+import { UploadPromiseAxiosResponse as UploadPromiseAxiosResponseType, FileDuiResponse as FileDuiResponseType, DropzoneUIResponse as DropzoneUIResponseType } from "./components/dropzone/components/utils/dropzone-ui.upload.utils";
+import { FileValidated as FileValidatedType, UPLOADSTATUS } from "./components/dropzone/components/utils/validation.utils";
+export type UploadPromiseAxiosResponse = UploadPromiseAxiosResponseType;
+export type FileDuiResponse = FileDuiResponseType;
+export type DropzoneUIResponse = DropzoneUIResponseType;
+export type FileValidated = FileValidatedType;
+export { createPDF, createWord, createListOfMultiTypeFile, createSyntheticFile, makeSynthticFileValidate, UPLOADSTATUS };
 
 export { default as Dropzone } from "./components/dropzone/components/Dropzone/Dropzone";
 export * from "./components/dropzone/components/Dropzone/Dropzone";

build/index.js

@@ -1,6 +1,12 @@
 import { SyntheticFile } from "./SyntheticFile";
 
-
+/**
+ * Creates a synthetic pdf File object instance
+ * @param name 
+ * @param size 
+ * @param type 
+ * @returns 
+ */
 export const createPDF = (
     name = "pdf-file-with-large-name.pdf",
     size = 455005,
@@ -9,6 +15,13 @@ export const createPDF = (
     return SyntheticFile.createFile(name, size, type);
 }
 
+/**
+ * Creates a synthetic word File object instance
+ * @param name 
+ * @param size 
+ * @param type 
+ * @returns 
+ */
 export const createWord = (
     name = "word-file-with-large-name.docx",
     size = 4555,
@@ -17,8 +30,26 @@ export const createWord = (
     return SyntheticFile.createFile(name, size, type);
 }
 
-
+/**
+ * Create a list of synthetic files with different mime types
+ * @param size the file size for each synthetic file
+ * @returns a list of synthetic file
+ */
 export const createListOfMultiTypeFile = (size?: number): File[] => {
-
     return SyntheticFile.createFileListMiscelanious(size);
+}
+/**
+ * Creates a synthetic file.
+ * By default, creates a png image file
+ * @param name the file name to show. By default is set to "png-image-file-with-large-name.png"
+ * @param size the size in bytes of the file. By default this value is set to 455555
+ * @param type the mime type of the file. By default is set to "image/png"
+ * @returns 
+ */
+export const createSyntheticFile = (
+    name = "png-image-file-with-large-name.png",
+    size = 455555,
+    type = "image/png",
+): File => {
+    return SyntheticFile.createFile(name, size, type);
 }