read-excel-file 5.2.26 → 5.2.27

package/README.md

@@ -320,11 +320,11 @@ readXlsxFile(file, { sheet: 'Sheet1' }).then((data) => {
 
 By default, `options.sheet` is `1`.
 
-To get the list of all sheets, pass `getSheets: true` option:
+To get the names of all sheets, use `readSheetNames()` function:
 
 ```js
-readXlsxFile(file, { getSheets: true }).then((sheets) => {
-  // sheets === [{ name: 'Sheet1' }, { name: 'Sheet2' }]
+readSheetNames(file).then((sheetNames) => {
+  // sheetNames === ['Sheet1', 'Sheet2']
 })
 ```
 

package/commonjs/read/readSheetNamesBrowser.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = readSheetNames;
+
+var _readXlsxFileBrowser = _interopRequireDefault(require("./readXlsxFileBrowser"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * Reads the list of sheet names in an XLSX file in a web browser.
+ * @param  {file} file - A file being uploaded in the browser.
+ * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.
+ */
+function readSheetNames(file) {
+  return (0, _readXlsxFileBrowser["default"])(file, {
+    getSheets: true
+  }).then(function (sheets) {
+    return sheets.map(function (sheet) {
+      return sheet.name;
+    });
+  });
+}
+//# sourceMappingURL=readSheetNamesBrowser.js.map

package/commonjs/read/readSheetNamesBrowser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesBrowser.js"],"names":["readSheetNames","file","getSheets","then","sheets","map","sheet","name"],"mappings":";;;;;;;AAAA;;;;AAEA;AACA;AACA;AACA;AACA;AACe,SAASA,cAAT,CAAwBC,IAAxB,EAA8B;AAC5C,SAAO,qCAAaA,IAAb,EAAmB;AAAEC,IAAAA,SAAS,EAAE;AAAb,GAAnB,EACLC,IADK,CACA,UAAAC,MAAM;AAAA,WAAIA,MAAM,CAACC,GAAP,CAAW,UAAAC,KAAK;AAAA,aAAIA,KAAK,CAACC,IAAV;AAAA,KAAhB,CAAJ;AAAA,GADN,CAAP;AAEA","sourcesContent":["import readXlsxFile from './readXlsxFileBrowser'\r\n\r\n/**\r\n * Reads the list of sheet names in an XLSX file in a web browser.\r\n * @param  {file} file - A file being uploaded in the browser.\r\n * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.\r\n */\r\nexport default function readSheetNames(file) {\r\n\treturn readXlsxFile(file, { getSheets: true })\r\n\t\t.then(sheets => sheets.map(sheet => sheet.name))\r\n}"],"file":"readSheetNamesBrowser.js"}

package/commonjs/read/readSheetNamesNode.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = readSheetNames;
+
+var _readXlsxFileNode = _interopRequireDefault(require("./readXlsxFileNode"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * Reads the list of sheet names in an XLSX file in Node.js.
+ * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.
+ * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.
+ */
+function readSheetNames(input) {
+  return (0, _readXlsxFileNode["default"])(input, {
+    getSheets: true
+  }).then(function (sheets) {
+    return sheets.map(function (sheet) {
+      return sheet.name;
+    });
+  });
+}
+//# sourceMappingURL=readSheetNamesNode.js.map

package/commonjs/read/readSheetNamesNode.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesNode.js"],"names":["readSheetNames","input","getSheets","then","sheets","map","sheet","name"],"mappings":";;;;;;;AAAA;;;;AAEA;AACA;AACA;AACA;AACA;AACe,SAASA,cAAT,CAAwBC,KAAxB,EAA+B;AAC7C,SAAO,kCAAaA,KAAb,EAAoB;AAAEC,IAAAA,SAAS,EAAE;AAAb,GAApB,EACLC,IADK,CACA,UAAAC,MAAM;AAAA,WAAIA,MAAM,CAACC,GAAP,CAAW,UAAAC,KAAK;AAAA,aAAIA,KAAK,CAACC,IAAV;AAAA,KAAhB,CAAJ;AAAA,GADN,CAAP;AAEA","sourcesContent":["import readXlsxFile from './readXlsxFileNode'\r\n\r\n/**\r\n * Reads the list of sheet names in an XLSX file in Node.js.\r\n * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.\r\n * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.\r\n */\r\nexport default function readSheetNames(input) {\r\n\treturn readXlsxFile(input, { getSheets: true })\r\n\t\t.then(sheets => sheets.map(sheet => sheet.name))\r\n}"],"file":"readSheetNamesNode.js"}

package/commonjs/read/readSheetNamesNode.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesNode.test.js"],"names":["describe","it","path","resolve","__dirname","then","sheetNames","should","deep","equal"],"mappings":";;AAAA;;AAEA;;;;AAEAA,QAAQ,CAAC,oBAAD,EAAuB,YAAM;AACpCC,EAAAA,EAAE,CAAC,kEAAD,EAAqE,YAAM;AAC5E,WAAO,oCAAmBC,iBAAKC,OAAL,CAAaC,SAAb,EAAwB,8CAAxB,CAAnB,EAA4FC,IAA5F,CAAiG,UAACC,UAAD,EAAgB;AACvHA,MAAAA,UAAU,CAACC,MAAX,CAAkBC,IAAlB,CAAuBC,KAAvB,CAA6B,CAAC,SAAD,EAAY,SAAZ,CAA7B;AACA,KAFM,CAAP;AAGA,GAJC,CAAF;AAKA,CANO,CAAR","sourcesContent":["import path from 'path'\r\n\r\nimport readSheetNamesNode from './readSheetNamesNode'\r\n\r\ndescribe('readSheetNamesNode', () => {\r\n\tit('should read the list of sheet names in an *.xlsx file in Node.js', () => {\r\n\t\treturn readSheetNamesNode(path.resolve(__dirname, '../../test/spreadsheets/multiple-sheets.xlsx')).then((sheetNames) => {\r\n\t\t\tsheetNames.should.deep.equal(['sheet 1', 'sheet 2'])\r\n\t\t})\r\n\t})\r\n})"],"file":"readSheetNamesNode.test.js"}

package/commonjs/read/readSheetNamesWebWorker.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = readSheetNames;
+
+var _readXlsxFileWebWorker = _interopRequireDefault(require("./readXlsxFileWebWorker"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * Reads the list of sheet names in an XLSX file in a Web Worker.
+ * @param  {file} file - The file.
+ * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.
+ */
+function readSheetNames(file) {
+  return (0, _readXlsxFileWebWorker["default"])(file, {
+    getSheets: true
+  }).then(function (sheets) {
+    return sheets.map(function (sheet) {
+      return sheet.name;
+    });
+  });
+}
+//# sourceMappingURL=readSheetNamesWebWorker.js.map

package/commonjs/read/readSheetNamesWebWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesWebWorker.js"],"names":["readSheetNames","file","getSheets","then","sheets","map","sheet","name"],"mappings":";;;;;;;AAAA;;;;AAEA;AACA;AACA;AACA;AACA;AACe,SAASA,cAAT,CAAwBC,IAAxB,EAA8B;AAC5C,SAAO,uCAAaA,IAAb,EAAmB;AAAEC,IAAAA,SAAS,EAAE;AAAb,GAAnB,EACLC,IADK,CACA,UAAAC,MAAM;AAAA,WAAIA,MAAM,CAACC,GAAP,CAAW,UAAAC,KAAK;AAAA,aAAIA,KAAK,CAACC,IAAV;AAAA,KAAhB,CAAJ;AAAA,GADN,CAAP;AAEA","sourcesContent":["import readXlsxFile from './readXlsxFileWebWorker'\r\n\r\n/**\r\n * Reads the list of sheet names in an XLSX file in a Web Worker.\r\n * @param  {file} file - The file.\r\n * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.\r\n */\r\nexport default function readSheetNames(file) {\r\n\treturn readXlsxFile(file, { getSheets: true })\r\n\t\t.then(sheets => sheets.map(sheet => sheet.name))\r\n}"],"file":"readSheetNamesWebWorker.js"}

package/index.commonjs.js

@@ -1,5 +1,6 @@
 exports = module.exports = require('./commonjs/read/readXlsxFileBrowser').default
 exports['default'] = require('./commonjs/read/readXlsxFileBrowser').default
+exports.readSheetNames = require('./commonjs/read/readSheetNamesBrowser').default
 exports.parseExcelDate = require('./commonjs/read/parseDate').default
 exports.Integer = require('./commonjs/types/Integer').default
 exports.Email = require('./commonjs/types/Email').default

package/index.d.ts

@@ -6,6 +6,11 @@ import {
 	Row
 } from './types.d';
 
+export {
+	ParsedObjectsResult,
+	Row
+} from './types.d';
+
 export function parseExcelDate(excelSerialDate: number) : typeof Date;
 
 type Input = File;
@@ -14,4 +19,6 @@ export function readXlsxFile<T extends object>(input: Input, options: ParseWithS
 export function readXlsxFile<T extends object>(input: Input, options: ParseWithMapOptions) : Promise<ParsedObjectsResult<T>>;
 export function readXlsxFile(input: Input, options?: ParseWithoutSchemaOptions) : Promise<Row[]>;
 
+export function readSheetNames(input: Input) : Promise<string[]>;
+
 export default readXlsxFile;

package/index.js

@@ -1,4 +1,5 @@
 export { default as default } from './modules/read/readXlsxFileBrowser'
+export { default as readSheetNames } from './modules/read/readSheetNamesBrowser'
 export { default as parseExcelDate } from './modules/read/parseDate'
 export { default as Integer } from './modules/types/Integer'
 export { default as Email } from './modules/types/Email'

package/modules/read/readSheetNamesBrowser.js

@@ -0,0 +1,17 @@
+import readXlsxFile from './readXlsxFileBrowser';
+/**
+ * Reads the list of sheet names in an XLSX file in a web browser.
+ * @param  {file} file - A file being uploaded in the browser.
+ * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.
+ */
+
+export default function readSheetNames(file) {
+  return readXlsxFile(file, {
+    getSheets: true
+  }).then(function (sheets) {
+    return sheets.map(function (sheet) {
+      return sheet.name;
+    });
+  });
+}
+//# sourceMappingURL=readSheetNamesBrowser.js.map

package/modules/read/readSheetNamesBrowser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesBrowser.js"],"names":["readXlsxFile","readSheetNames","file","getSheets","then","sheets","map","sheet","name"],"mappings":"AAAA,OAAOA,YAAP,MAAyB,uBAAzB;AAEA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,cAAT,CAAwBC,IAAxB,EAA8B;AAC5C,SAAOF,YAAY,CAACE,IAAD,EAAO;AAAEC,IAAAA,SAAS,EAAE;AAAb,GAAP,CAAZ,CACLC,IADK,CACA,UAAAC,MAAM;AAAA,WAAIA,MAAM,CAACC,GAAP,CAAW,UAAAC,KAAK;AAAA,aAAIA,KAAK,CAACC,IAAV;AAAA,KAAhB,CAAJ;AAAA,GADN,CAAP;AAEA","sourcesContent":["import readXlsxFile from './readXlsxFileBrowser'\r\n\r\n/**\r\n * Reads the list of sheet names in an XLSX file in a web browser.\r\n * @param  {file} file - A file being uploaded in the browser.\r\n * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.\r\n */\r\nexport default function readSheetNames(file) {\r\n\treturn readXlsxFile(file, { getSheets: true })\r\n\t\t.then(sheets => sheets.map(sheet => sheet.name))\r\n}"],"file":"readSheetNamesBrowser.js"}

package/modules/read/readSheetNamesNode.js

@@ -0,0 +1,17 @@
+import readXlsxFile from './readXlsxFileNode';
+/**
+ * Reads the list of sheet names in an XLSX file in Node.js.
+ * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.
+ * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.
+ */
+
+export default function readSheetNames(input) {
+  return readXlsxFile(input, {
+    getSheets: true
+  }).then(function (sheets) {
+    return sheets.map(function (sheet) {
+      return sheet.name;
+    });
+  });
+}
+//# sourceMappingURL=readSheetNamesNode.js.map

package/modules/read/readSheetNamesNode.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesNode.js"],"names":["readXlsxFile","readSheetNames","input","getSheets","then","sheets","map","sheet","name"],"mappings":"AAAA,OAAOA,YAAP,MAAyB,oBAAzB;AAEA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,cAAT,CAAwBC,KAAxB,EAA+B;AAC7C,SAAOF,YAAY,CAACE,KAAD,EAAQ;AAAEC,IAAAA,SAAS,EAAE;AAAb,GAAR,CAAZ,CACLC,IADK,CACA,UAAAC,MAAM;AAAA,WAAIA,MAAM,CAACC,GAAP,CAAW,UAAAC,KAAK;AAAA,aAAIA,KAAK,CAACC,IAAV;AAAA,KAAhB,CAAJ;AAAA,GADN,CAAP;AAEA","sourcesContent":["import readXlsxFile from './readXlsxFileNode'\r\n\r\n/**\r\n * Reads the list of sheet names in an XLSX file in Node.js.\r\n * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.\r\n * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.\r\n */\r\nexport default function readSheetNames(input) {\r\n\treturn readXlsxFile(input, { getSheets: true })\r\n\t\t.then(sheets => sheets.map(sheet => sheet.name))\r\n}"],"file":"readSheetNamesNode.js"}

package/modules/read/readSheetNamesNode.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesNode.test.js"],"names":["path","readSheetNamesNode","describe","it","resolve","__dirname","then","sheetNames","should","deep","equal"],"mappings":"AAAA,OAAOA,IAAP,MAAiB,MAAjB;AAEA,OAAOC,kBAAP,MAA+B,sBAA/B;AAEAC,QAAQ,CAAC,oBAAD,EAAuB,YAAM;AACpCC,EAAAA,EAAE,CAAC,kEAAD,EAAqE,YAAM;AAC5E,WAAOF,kBAAkB,CAACD,IAAI,CAACI,OAAL,CAAaC,SAAb,EAAwB,8CAAxB,CAAD,CAAlB,CAA4FC,IAA5F,CAAiG,UAACC,UAAD,EAAgB;AACvHA,MAAAA,UAAU,CAACC,MAAX,CAAkBC,IAAlB,CAAuBC,KAAvB,CAA6B,CAAC,SAAD,EAAY,SAAZ,CAA7B;AACA,KAFM,CAAP;AAGA,GAJC,CAAF;AAKA,CANO,CAAR","sourcesContent":["import path from 'path'\r\n\r\nimport readSheetNamesNode from './readSheetNamesNode'\r\n\r\ndescribe('readSheetNamesNode', () => {\r\n\tit('should read the list of sheet names in an *.xlsx file in Node.js', () => {\r\n\t\treturn readSheetNamesNode(path.resolve(__dirname, '../../test/spreadsheets/multiple-sheets.xlsx')).then((sheetNames) => {\r\n\t\t\tsheetNames.should.deep.equal(['sheet 1', 'sheet 2'])\r\n\t\t})\r\n\t})\r\n})"],"file":"readSheetNamesNode.test.js"}

package/modules/read/readSheetNamesWebWorker.js

@@ -0,0 +1,17 @@
+import readXlsxFile from './readXlsxFileWebWorker';
+/**
+ * Reads the list of sheet names in an XLSX file in a Web Worker.
+ * @param  {file} file - The file.
+ * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.
+ */
+
+export default function readSheetNames(file) {
+  return readXlsxFile(file, {
+    getSheets: true
+  }).then(function (sheets) {
+    return sheets.map(function (sheet) {
+      return sheet.name;
+    });
+  });
+}
+//# sourceMappingURL=readSheetNamesWebWorker.js.map

package/modules/read/readSheetNamesWebWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readSheetNamesWebWorker.js"],"names":["readXlsxFile","readSheetNames","file","getSheets","then","sheets","map","sheet","name"],"mappings":"AAAA,OAAOA,YAAP,MAAyB,yBAAzB;AAEA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,cAAT,CAAwBC,IAAxB,EAA8B;AAC5C,SAAOF,YAAY,CAACE,IAAD,EAAO;AAAEC,IAAAA,SAAS,EAAE;AAAb,GAAP,CAAZ,CACLC,IADK,CACA,UAAAC,MAAM;AAAA,WAAIA,MAAM,CAACC,GAAP,CAAW,UAAAC,KAAK;AAAA,aAAIA,KAAK,CAACC,IAAV;AAAA,KAAhB,CAAJ;AAAA,GADN,CAAP;AAEA","sourcesContent":["import readXlsxFile from './readXlsxFileWebWorker'\r\n\r\n/**\r\n * Reads the list of sheet names in an XLSX file in a Web Worker.\r\n * @param  {file} file - The file.\r\n * @return {Promise} Resolves to an array of objects of shape `{ name: string }`.\r\n */\r\nexport default function readSheetNames(file) {\r\n\treturn readXlsxFile(file, { getSheets: true })\r\n\t\t.then(sheets => sheets.map(sheet => sheet.name))\r\n}"],"file":"readSheetNamesWebWorker.js"}

package/node/index.commonjs.js

@@ -1,5 +1,6 @@
 exports = module.exports = require('../commonjs/read/readXlsxFileNode').default
 exports['default'] = require('../commonjs/read/readXlsxFileNode').default
+exports.readSheetNames = require('../commonjs/read/readSheetNamesNode').default
 exports.parseExcelDate = require('../commonjs/read/parseDate').default
 exports.Integer = require('../commonjs/types/Integer').default
 exports.Email = require('../commonjs/types/Email').default

package/node/index.d.ts

@@ -12,6 +12,11 @@ import {
 	Row
 } from '../types.d';
 
+export {
+	ParsedObjectsResult,
+	Row
+} from '../types.d';
+
 export function parseExcelDate(excelSerialDate: number) : typeof Date;
 
 type Input = Stream | PathLike;
@@ -20,4 +25,6 @@ export function readXlsxFile<T extends object>(input: Input, options: ParseWithS
 export function readXlsxFile<T extends object>(input: Input, options: ParseWithMapOptions) : Promise<ParsedObjectsResult<T>>;
 export function readXlsxFile(input: Input, options?: ParseWithoutSchemaOptions) : Promise<Row[]>;
 
+export function readSheetNames(input: Input) : Promise<string[]>;
+
 export default readXlsxFile;

package/node/index.js

@@ -1,4 +1,5 @@
 export { default as default } from '../modules/read/readXlsxFileNode'
+export { default as readSheetNames } from '../modules/read/readSheetNamesNode'
 export { default as parseExcelDate } from '../modules/read/parseDate'
 export { default as Integer } from '../modules/types/Integer'
 export { default as Email } from '../modules/types/Email'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "read-excel-file",
-  "version": "5.2.26",
+  "version": "5.2.27",
   "description": "Read small to medium `*.xlsx` files in a browser or Node.js. Parse to JSON with a strict schema.",
   "module": "index.js",
   "sideEffects": false,

package/web-worker/index.commonjs.js

@@ -1,5 +1,6 @@
 exports = module.exports = require('../commonjs/read/readXlsxFileWebWorker').default
 exports['default'] = require('../commonjs/read/readXlsxFileWebWorker').default
+exports.readSheetNames = require('../commonjs/read/readSheetNamesWebWorker').default
 exports.parseExcelDate = require('../commonjs/read/parseDate').default
 exports.Integer = require('../commonjs/types/Integer').default
 exports.Email = require('../commonjs/types/Email').default

package/web-worker/index.d.ts

@@ -6,6 +6,11 @@ import {
 	Row
 } from '../types.d';
 
+export {
+	ParsedObjectsResult,
+	Row
+} from '../types.d';
+
 export function parseExcelDate(excelSerialDate: number) : typeof Date;
 
 type Input = File;
@@ -14,4 +19,6 @@ export function readXlsxFile<T extends object>(input: Input, options: ParseWithS
 export function readXlsxFile<T extends object>(input: Input, options: ParseWithMapOptions) : Promise<ParsedObjectsResult<T>>;
 export function readXlsxFile(input: Input, options?: ParseWithoutSchemaOptions) : Promise<Row[]>;
 
+export function readSheetNames(input: Input) : Promise<string[]>;
+
 export default readXlsxFile;

package/web-worker/index.js

@@ -1,4 +1,5 @@
 export { default as default } from '../modules/read/readXlsxFileWebWorker'
+export { default as readSheetNames } from '../modules/read/readSheetNamesWebWorker'
 export { default as parseExcelDate } from '../modules/read/parseDate'
 export { default as Integer } from '../modules/types/Integer'
 export { default as Email } from '../modules/types/Email'