read-excel-file 2.0.5 → 2.0.10

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+<!-- 3.0.0 — Don't return empty data in case of an error; throw the error instead. -->
+
 2.0.1 / 26.06.2018
 ==================
 

package/README.md

@@ -32,7 +32,7 @@ input.addEventListener('change', () => {
 ## Node.js
 
 ```js
-import readXlsxFile from 'read-excel-file/node'
+const readXlsxFile = require('read-excel-file/node');
 
 // File path.
 readXlsxFile('/path/to/file').then((rows) => {
@@ -165,17 +165,25 @@ Node.js `*.xlxs` parser uses `xpath` and `xmldom` universal packages for XML par
 By default it reads the first sheet in the document. If you have multiple sheets in your spreadsheet then pass `sheet: number` or `sheet: string` as part of the `options` argument (`options.sheet` is `1` by default):
 
 ```js
-readXlsxFile(selectedFile, { sheet: 2 }).then((data) => {
+readXlsxFile(file, { sheet: 2 }).then((data) => {
   ...
 })
 ```
 
 ```js
-readXlsxFile(selectedFile, { sheet: 'Sheet1' }).then((data) => {
+readXlsxFile(file, { sheet: 'Sheet1' }).then((data) => {
   ...
 })
 ```
 
+To get the list of sheets one can pass `getSheets: true` option:
+
+```js
+readXlsxFile(file, { getSheets: true }).then((sheets) => {
+  // sheets === { 1: 'Sheet1', 2: 'Sheet2' }
+})
+```
+
 ## References
 
 For XML parsing [`xmldom`](https://github.com/jindw/xmldom) and [`xpath`](https://github.com/goto100/xpath) are used.