@@ -1035,15 +1035,15 @@ export type InferOutputByType<T extends "Blob" | "Uint8Array"> = T extends "Blob
1035
1035
*/
1036
1036
export declare function createWorkbook ( ) : Workbook ;
1037
1037
/**
1038
- * Turns a workbook into a downloadable file, you can between a ' Blob' or ' Uint8Array' ,
1039
- * and if nothing is provided then ' Blob' will be the default
1038
+ * Turns a Workbook into a downloadable file, you can switch output type a ` Blob` or ` Uint8Array` ,
1039
+ * and if nothing is provided then ` Blob` is the default output type.
1040
1040
* @param {Excel/Workbook } workbook - The workbook that is being converted
1041
1041
* @param {'Uint8Array' | 'Blob' } [outputType='Blob'] - defaults to 'Blob'
1042
1042
* @param {Object } [options]
1043
1043
* - `fileFormat` defaults to "xlsx"
1044
- * - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension .xls/ .xlsx)
1044
+ * - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension ` .xls`/` .xlsx` )
1045
1045
* (user can pass an empty string to completely cancel the mime type altogether)
1046
- * - `zipOptions` to specify any `fflate` options to modify how the zip is created.
1046
+ * - `zipOptions` to specify any `fflate` options to modify how the zip will be created.
1047
1047
* @returns {Promise }
1048
1048
*/
1049
1049
export declare function createExcelFile < T extends "Blob" | "Uint8Array" = "Blob" > ( workbook : Workbook , outputType ?: T , options ?: {
@@ -1053,11 +1053,11 @@ export declare function createExcelFile<T extends "Blob" | "Uint8Array" = "Blob"
1053
1053
} ) : Promise < InferOutputByType < T > > ;
1054
1054
/**
1055
1055
* Download Excel file, currently only supports a "browser" as `downloadType`
1056
- * but it could be expended in the future to also other type of platform like NodeJS for example.
1056
+ * but it could be expended in the future to also support other type of platforms like NodeJS for example.
1057
1057
* @param {Workbook } workbook
1058
- * @param {String } filename - filename (must also include file extension, xls/ xlsx)
1058
+ * @param {String } filename - filename (must also include file extension: `. xls` or `. xlsx` )
1059
1059
* @param {Object } [options]
1060
- * - `downloadType`: download type (browser/ node), currently only a "browser" download as a Blob
1060
+ * - `downloadType`: download type (' browser' / ' node' ), currently only supports "browser" download as a Blob
1061
1061
* - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension .xls/.xlsx)
1062
1062
* (user can pass an empty string to completely cancel the mime type altogether)
1063
1063
* - `zipOptions` to specify any `fflate` options to modify how the zip is created.
0 commit comments