#inspect() JSON schema, version 1

inspect(input, options?) (and inspectFile(path, options?) from xlvane/node) returns plain JSON data describing a workbook. JSON.stringify of the result is lossless. The field schemaVersion changes only when a field is removed or changes meaning; new fields may be added within a version.

#Options

#Workbook

#Sheet

Header detection. Among the first headerScanRows non-empty rows, the header row is the first one in which:

• cells with a formula are left out (a total such as =SUM(B3:B9) may sit next to the column names);
• every other cell is non-blank text or a year: a whole number from 1900 to 2100 (Region | 2023 | 2024). The years of the row must be consecutive, and in the next non-empty row at least one value below them must not be such a year, so that a data row with years (Alice | 1985) is not taken for a header;
• at least one cell is text, and the cells cover at least half of the used width.

Repeated names are allowed; readTable gives the second one the key name_2, and so on. The confidence is "high" when the names are distinct and the next non-empty row contains a value that is not text (number, date, boolean or error), otherwise "low". A year used as a column name is reported as text in header ("2023"). This is a heuristic; check confidence before relying on it, or give the header row yourself (readTable(…, { header: 2 }), xlvane read --header 2).

#Column

Values in samples are JSON-safe: numbers, booleans, strings (cut to 100 characters) and dates as ISO 8601 strings without a time zone, as in CSV: the date alone at midnight ("2024-01-31"), otherwise date and time ("2024-01-31T13:45:00", with .sss when there are milliseconds), because spreadsheet dates have no time zone. Error cells appear as their code, e.g. "#DIV/0!".

#Warning

#Example

{
  "schemaVersion": 1,
  "format": "xlsx",
  "conformance": "transitional",
  "dateSystem": "1900",
  "hasMacros": false,
  "externalLinkCount": 0,
  "properties": { "title": "Sales 2024", "creator": "Finance" },
  "definedNames": [{ "name": "Total", "refersTo": "Sales!$C$3", "sheet": null, "hidden": false }],
  "definedNamesTruncated": false,
  "sheetCount": 1,
  "sheets": [
    {
      "name": "Sales",
      "index": 0,
      "sheetId": 1,
      "kind": "worksheet",
      "state": "visible",
      "dimension": "A1:C3",
      "usedRange": "A1:C3",
      "cellCount": 9,
      "formulaCount": 1,
      "mergedRanges": [],
      "mergedRangeCount": 0,
      "mergedRangesTruncated": false,
      "formulas": [{ "cell": "C3", "formula": "SUM(C2:C2)" }],
      "richTextCellCount": 0,
      "richTextCells": [],
      "styledColumns": [],
      "hyperlinkCount": 0,
      "hyperlinks": [],
      "noteCount": 0,
      "imageCount": 0,
      "images": [],
      "notes": [],
      "protected": false,
      "printArea": null,
      "pageBreakCount": 0,
      "dataValidationCount": 0,
      "conditionalFormatCount": 0,
      "tables": [],
      "rowCount": 3,
      "columnCount": 3,
      "headerRow": { "row": 1, "confidence": "high" },
      "columns": [
        { "index": 1, "letter": "A", "header": "Date", "dominantType": "date", "types": { "number": 0, "string": 0, "boolean": 0, "date": 2, "error": 0, "empty": 0 }, "samples": ["2024-01-31", "2024-02-01"] },
        { "index": 2, "letter": "B", "header": "Customer", "dominantType": "string", "types": { "number": 0, "string": 1, "boolean": 0, "date": 0, "error": 0, "empty": 1 }, "samples": ["ACME"] },
        { "index": 3, "letter": "C", "header": "Amount", "dominantType": "number", "types": { "number": 2, "string": 0, "boolean": 0, "date": 0, "error": 0, "empty": 0 }, "samples": [100.5] }
      ],
      "columnsTruncated": false
    }
  ],
  "warnings": []
}

Source: docs/inspect-json.md (version 1.2.2)