@@ -25,15 +25,15 @@ export function base64ToUint8Array(base64String: string) {
25
25
}
26
26
27
27
/**
28
- * Turns a workbook into a downloadable file, you can between a ' Blob' or ' Uint8Array' ,
29
- * and if nothing is provided then ' Blob' will be the default
28
+ * Turns a Workbook into a downloadable file, you can switch output type a ` Blob` or ` Uint8Array` ,
29
+ * and if nothing is provided then ` Blob` is the default output type.
30
30
* @param {Excel/Workbook } workbook - The workbook that is being converted
31
31
* @param {'Uint8Array' | 'Blob' } [outputType='Blob'] - defaults to 'Blob'
32
32
* @param {Object } [options]
33
33
* - `fileFormat` defaults to "xlsx"
34
- * - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension .xls/ .xlsx)
34
+ * - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension ` .xls`/` .xlsx` )
35
35
* (user can pass an empty string to completely cancel the mime type altogether)
36
- * - `zipOptions` to specify any `fflate` options to modify how the zip is created.
36
+ * - `zipOptions` to specify any `fflate` options to modify how the zip will be created.
37
37
* @returns {Promise }
38
38
*/
39
39
export function createExcelFile < T extends 'Blob' | 'Uint8Array' = 'Blob' > (
@@ -78,11 +78,11 @@ export function createExcelFile<T extends 'Blob' | 'Uint8Array' = 'Blob'>(
78
78
79
79
/**
80
80
* Download Excel file, currently only supports a "browser" as `downloadType`
81
- * but it could be expended in the future to also other type of platform like NodeJS for example.
81
+ * but it could be expended in the future to also support other type of platforms like NodeJS for example.
82
82
* @param {Workbook } workbook
83
- * @param {String } filename - filename (must also include file extension, xls/ xlsx)
83
+ * @param {String } filename - filename (must also include file extension: `. xls` or `. xlsx` )
84
84
* @param {Object } [options]
85
- * - `downloadType`: download type (browser/ node), currently only a "browser" download as a Blob
85
+ * - `downloadType`: download type (' browser' / ' node' ), currently only supports "browser" download as a Blob
86
86
* - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension .xls/.xlsx)
87
87
* (user can pass an empty string to completely cancel the mime type altogether)
88
88
* - `zipOptions` to specify any `fflate` options to modify how the zip is created.
@@ -108,8 +108,8 @@ export function downloadExcelFile(
108
108
109
109
/**
110
110
* Download Excel file, currently only supports a "browser" as `downloadType`,
111
- * but it could probably be expended to support other platform in the future like NodeJS for example.
112
- * @param {String } filename - filename (must also include file extension, xls/ xlsx)
111
+ * but it could be expended in the future to also support other type of platforms like NodeJS for example.
112
+ * @param {String } filename - filename (must also include file extension: `. xls` or `. xlsx` )
113
113
* @param {Blob } data - compressed data object
114
114
*/
115
115
function downloadFileToBrowser ( filename : string , data : Blob ) {
0 commit comments