wb.functions

WorkbookFunctions

8 methods

invoke

→ Promise<CellValue>

invoke(functionName: string, ...args: unknown[]): Promise<CellValue>;

Parameter	Type	Required
functionName	string	required

Invoke any spreadsheet function by name with arbitrary arguments. @param functionName - The function name (e.g. 'VLOOKUP', 'SUM'). @param args - Arguments: cell/range refs as strings, literals as values. @returns The evaluated result.

CellValue

vlookup

→ Promise<CellValue>

vlookup(
    lookupValue: CellValue,
    tableArray: string,
    colIndex: number,
    rangeLookup?: boolean,
  ): Promise<CellValue>;

Parameter	Type	Required
lookupValue	CellValue	required
tableArray	string	required
colIndex	number	required
rangeLookup	boolean	optional

VLOOKUP function. @param lookupValue - The value to search for. @param tableArray - The range reference (e.g. "A1:C10"). @param colIndex - Column index (1-based) to return. @param rangeLookup - Whether to use approximate match (default: false).

CellValue

sum

→ Promise<number>

sum(...ranges: string[]): Promise<number>;

SUM function.

average

→ Promise<number>

average(...ranges: string[]): Promise<number>;

AVERAGE function.

count

→ Promise<number>

count(...ranges: string[]): Promise<number>;

COUNT function.

max

→ Promise<number>

max(...ranges: string[]): Promise<number>;

MAX function.

min

→ Promise<number>

min(...ranges: string[]): Promise<number>;

MIN function.

concatenate

→ Promise<string>

concatenate(...values: CellValue[]): Promise<string>;

CONCATENATE function.

CellValue