zhoupeng 6d46d117cd 编辑器 1 year ago
..
lib 6d46d117cd 编辑器 1 year ago
src 6d46d117cd 编辑器 1 year ago
test 6d46d117cd 编辑器 1 year ago
.babelrc 6d46d117cd 编辑器 1 year ago
.eslintrc 6d46d117cd 编辑器 1 year ago
.travis.yml 6d46d117cd 编辑器 1 year ago
LICENSE.md 6d46d117cd 编辑器 1 year ago
README.md 6d46d117cd 编辑器 1 year ago
package.json 6d46d117cd 编辑器 1 year ago

README.md

Node XLSX

npm version license build status dependencies status devDependencies status Codacy Badge Codacy Badge npm downloads

Excel file parser/builder that relies on js-xlsx.

Usage

Examples

  1. Parsing a xlsx from file/buffer, outputs an array of worksheets
import xlsx from 'node-xlsx';
// Or var xlsx = require('node-xlsx').default;

// Parse a buffer
const workSheetsFromBuffer = xlsx.parse(fs.readFileSync(`${__dirname}/myFile.xlsx`));
// Parse a file
const workSheetsFromFile = xlsx.parse(`${__dirname}/myFile.xlsx`);
  1. Building a xlsx
import xlsx from 'node-xlsx';
// Or var xlsx = require('node-xlsx').default;

const data = [[1, 2, 3], [true, false, null, 'sheetjs'], ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'], ['baz', null, 'qux']];
var buffer = xlsx.build([{name: "mySheetName", data: data}]); // Returns a buffer
  • Building a xlsx (spannig multiple rows A1:A4) ```js import xlsx from 'node-xlsx'; // Or var xlsx = require('node-xlsx').default;

const data = [[1, 2, 3], [true, false, null, 'sheetjs'], ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'], ['baz', null, 'qux']]; const range = {s: {c: 0, r:0 }, e: {c:0, r:3}}; // A1:A4 const option = {'!merges': [ range ]};

var buffer = xlsx.build([{name: "mySheetName", data: data}], option); // Returns a buffer

  

### Troubleshooting

This library requires at lease nodeJS v4. For legacy versions, you can use this workaround before using the lib.

npm i --save object-assign Object.prototype.assign = require('object-assign');



### Contributing

Please submit all pull requests the against master branch. If your unit test contains javascript patches or features, you should include relevant unit tests. Thanks!


### Available scripts

| **Script** | **Description** |
|----------|-------|
| start | Alias of test:watch |
| test | Run mocha unit tests |
| test:watch | Run and watch mocha unit tests |
| lint | Run eslint static tests |
| compile | Compile the library |
| compile:watch | Compile and watch the library |


## Authors

**Olivier Louvignes**

+ http://olouv.com
+ http://github.com/mgcrea


## Copyright and license

[Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html)

Copyright (C) 2012-2014 Olivier Louvignes

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Except where noted, this license applies to any and all software programs and associated documentation files created by the Original Author and distributed with the Software:

Inspired by SheetJS gist examples, Copyright (c) SheetJS. ```