readInputsSheet()
function readInputsSheet(workbook, configVars?): InputSpec[];
Defined in: src/parser.ts:791
Parse the optional __inputs__ sheet (ADR-0010 / ADR-0011). The
first row is the header; each subsequent row declares one input.
Columns are identified by header text, case-insensitive.
Per ADR-0050, cells in the default, label, description, and
options columns are XTL templates evaluated against a constrained
context (only __config__ + pure scalar functions; no source data,
no forward refs to other inputs).
Parameters
| Parameter | Type |
|---|---|
workbook | Workbook |
configVars | Record<string, string> |
Returns
Stable
Frozen at 1.0 per spec/STABILITY.md "Public API surface".
Example
const wb = new ExcelJS.Workbook();
await wb.xlsx.load(templateBuffer);
const { configVars } = readConfigSheet(wb);
const specs = readInputsSheet(wb, configVars);
// specs[0] === { name: 'month', type: 'string', default: '2026-05', ... }