1. module node-xlsx
   1. function node-xlsx.build (worksheets)
   2. function node-xlsx.parse (mixed)
   3. object node-xlsx.default
   4. object node-xlsx.helpers
   5. object node-xlsx.workbook
2. module node-xlsx.default
   1. function node-xlsx.default.build (worksheets)
   2. function node-xlsx.default.parse (mixed)
3. module node-xlsx.helpers
   1. function node-xlsx.helpers.buildSheetFromMatrix (data)
   2. function node-xlsx.helpers.isBoolean (maybeBoolean)
   3. function node-xlsx.helpers.isNumber (maybeNumber)
   4. function node-xlsx.helpers.isString (maybeString)
4. module node-xlsx.workbook
   1. function node-xlsx.workbook.default ()

module node-xlsx

function node-xlsx.build (worksheets)

• description and source-code

  function build(worksheets) {
    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
    var defaults = {
      bookType: 'xlsx',
      bookSST: false,
      type: 'binary'
    };
    var workBook = new _workbook2.default();
    worksheets.forEach(function (worksheet) {
      var name = worksheet.name || 'Sheet';
      var data = (0, _helpers.buildSheetFromMatrix)(worksheet.data || [], options);
      workBook.SheetNames.push(name);
      workBook.Sheets[name] = data;
    });
    var excelData = _xlsx2.default.write(workBook, Object.assign({}, defaults, options));
    return excelData instanceof Buffer ? excelData : new Buffer(excelData, 'binary');
  }

• example usage

  n/a

function node-xlsx.parse (mixed)

• description and source-code

  function parse(mixed) {
    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
    var workSheet = _xlsx2.default[(0, _helpers.isString)(mixed) ? 'readFile' : 'read'](mixed, options);
    return Object.keys(workSheet.Sheets).map(function (name) {
      var sheet = workSheet.Sheets[name];
      return { name: name, data: _xlsx2.default.utils.sheet_to_json(sheet, { header: 1, raw: true }) };
    });
  }

• example usage

  ...
  var isString = function isString(maybeString) {
  return typeof maybeString === 'string';
  };
  
  var originDate = new Date(Date.UTC(1899, 11, 30));
  
  var buildExcelDate = function buildExcelDate(value, is1904) {
  var epoch = Date.parse(value + (is1904 ? 1462 : 0));
  return (epoch - originDate) / 864e5;
  };
  
  var buildSheetFromMatrix = function buildSheetFromMatrix(data) {
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
  var workSheet = {};
  ...

module node-xlsx.default

function node-xlsx.default.build (worksheets)

• description and source-code

  function build(worksheets) {
    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
    var defaults = {
      bookType: 'xlsx',
      bookSST: false,
      type: 'binary'
    };
    var workBook = new _workbook2.default();
    worksheets.forEach(function (worksheet) {
      var name = worksheet.name || 'Sheet';
      var data = (0, _helpers.buildSheetFromMatrix)(worksheet.data || [], options);
      workBook.SheetNames.push(name);
      workBook.Sheets[name] = data;
    });
    var excelData = _xlsx2.default.write(workBook, Object.assign({}, defaults, options));
    return excelData instanceof Buffer ? excelData : new Buffer(excelData, 'binary');
  }

• example usage

  n/a

function node-xlsx.default.parse (mixed)

• description and source-code

  function parse(mixed) {
    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
    var workSheet = _xlsx2.default[(0, _helpers.isString)(mixed) ? 'readFile' : 'read'](mixed, options);
    return Object.keys(workSheet.Sheets).map(function (name) {
      var sheet = workSheet.Sheets[name];
      return { name: name, data: _xlsx2.default.utils.sheet_to_json(sheet, { header: 1, raw: true }) };
    });
  }

• example usage

  ...
  var isString = function isString(maybeString) {
  return typeof maybeString === 'string';
  };
  
  var originDate = new Date(Date.UTC(1899, 11, 30));
  
  var buildExcelDate = function buildExcelDate(value, is1904) {
  var epoch = Date.parse(value + (is1904 ? 1462 : 0));
  return (epoch - originDate) / 864e5;
  };
  
  var buildSheetFromMatrix = function buildSheetFromMatrix(data) {
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
  var workSheet = {};
  ...

module node-xlsx.helpers

function node-xlsx.helpers.buildSheetFromMatrix (data)

• description and source-code

  function buildSheetFromMatrix(data) {
    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
    var workSheet = {};
    var range = { s: { c: 1e7, r: 1e7 }, e: { c: 0, r: 0 } };
    for (var R = 0; R !== data.length; ++R) {
      for (var C = 0; C !== data[R].length; ++C) {
        if (range.s.r > R) range.s.r = R;
        if (range.s.c > C) range.s.c = C;
        if (range.e.r < R) range.e.r = R;
        if (range.e.c < C) range.e.c = C;
        if (data[R][C] === null) {
          continue; // eslint-disable-line
        }
        var cell = { v: data[R][C] };
        var cellRef = _xlsx2.default.utils.encode_cell({ c: C, r: R });
        if (isNumber(cell.v)) {
          cell.t = 'n';
        } else if (isBoolean(cell.v)) {
          cell.t = 'b';
        } else if (cell.v instanceof Date) {
          cell.t = 'n';
          cell.v = buildExcelDate(cell.v);
          cell.z = _xlsx2.default.SSF._table[14]; // eslint-disable-line no-underscore-dangle
        } else {
          cell.t = 's';
        }
        workSheet[cellRef] = cell;
      }
    }
    if (range.s.c < 1e7) {
      workSheet['!ref'] = _xlsx2.default.utils.encode_range(range);
    }
    if (options['!cols']) {
      workSheet['!cols'] = options['!cols'];
    }
    if (options['!merges']) {
      workSheet['!merges'] = options['!merges'];
    }
    return workSheet;
  }

• example usage

  n/a

function node-xlsx.helpers.isBoolean (maybeBoolean)

• description and source-code

  function isBoolean(maybeBoolean) {
    return typeof maybeBoolean === 'boolean';
  }

• example usage

  n/a

function node-xlsx.helpers.isNumber (maybeNumber)

• description and source-code

  function isNumber(maybeNumber) {
    return typeof maybeNumber === 'number';
  }

• example usage

  n/a

function node-xlsx.helpers.isString (maybeString)

• description and source-code

  function isString(maybeString) {
    return typeof maybeString === 'string';
  }

• example usage

  n/a

module node-xlsx.workbook

function node-xlsx.workbook.default ()

• description and source-code

  function Workbook() {
    _classCallCheck(this, Workbook);
  
    this.SheetNames = [];
    this.Sheets = {};
  }

• example usage

  n/a