Skip to main content

readConfigSheet()

function readConfigSheet(workbook): ConfigResult;

Defined in: src/parser.ts:915

Read the __config__ sheet and return parsed template metadata plus any author-defined config variables.

Parameters​

ParameterType
workbookWorkbook

Returns​

ConfigResult

Stable​

Frozen at 1.0 per spec/STABILITY.md "Public API surface".

Example​

const wb = new ExcelJS.Workbook();
await wb.xlsx.load(templateBuffer);
const { meta, configVars } = readConfigSheet(wb);
console.log(meta.name, meta.output_file_pattern);