Skip to content

Function: getWorksheet()

ts
function getWorksheet(workbook: Workbook, identifier: string | number | RegExp): Worksheet | undefined;

Defined in: src/excel/excel.tsx:391

Retrieve a worksheet by index, name, or RegExp pattern.

Parameters

ParameterTypeDescription
workbookWorkbookThe ExcelJS workbook instance.
identifierstring | number | RegExpA zero-based index, sheet name, or RegExp pattern.

Returns

Worksheet | undefined

The matched worksheet or undefined.

Example

ts
const sheet = getWorksheet(workbook, 'Employees');
const first = getWorksheet(workbook, 0);
const match = getWorksheet(workbook, /Revenue/);

Matterway Assistant SDK Documentation