@chidoan/excel-utils
v3.1.1
Published
Provide utilities to transform between json and excel file
Downloads
62
Maintainers
Readme
Excel Utils
Provide the simple way to read and write excel file by JSON at client side.
+ Importer: read content of excel file to JSON
+ Exporter: build excel file and auto download
1. Installation
You can add this dependence to your project by npm
$ npm i @chidoan/excel-utils
or yarn
$ yarn add @chidoan/excel-utils`
2. Guideline
Importer
| Function | Description |
| ------ | ------ |
| readXLSX(file, worksheets, options) | Read sheets from worksheets in source file, and result is map data with sheet name as key. - file: File - worksheets: String[] - options: Object. Support to read binary file with { rABS = true }
and base64 as default |
| readXLSXAllSheet(file, options) | Base on readXLSX
, this function read all available sheets on source file |
| correctJsonPropertyName(sheet_data, properties) | The readXLSX
function use column name as key for json object. This function use to correct key name and data type |
Example at Github
Exporter
| Function | Description | | ------ | ------ | | Exporter(filename) | Receive STRING as target filename | | setFilename(filename) | Set target filename | | setConfigurations(options) | Optional for style. - REPLACE_UNKNOWN_TO_EMPTY: Boolean> Auto change NULL and UNDEFINED value to empty string - DECORATE_BORDER: Boolean - DECORATE_HEADER_COLOR: String | | addSheet(headers, data, sheetName) | Exporter support to combine to multiple sheet. - headers: Object - data: Array - sheetName: String | | exportExcel() | Export and auto download file
Example at Github
3. Dependencies
- downloadjs
- lodash
- moment
- xlsx