read-excel-file/node/index.d.ts

Read small to medium `*.xlsx` files in a browser or Node.js. Parse to JSON with a strict schema.

// See the discussion:
// https://github.com/catamphetamine/read-excel-file/issues/71

import { PathLike } from 'fs';
import { Stream } from 'stream';

import {
	ParseWithSchemaOptions,
	ParseWithMapOptions,
	ParseWithoutSchemaOptions,
	ParsedObjectsResult,
	Row
} from '../types.d.js';

export {
	Schema,
	ParsedObjectsResult,
	Error,
	CellValue,
	Row,
	Integer,
	Email,
	URL
} from '../types.d.js';

export function parseExcelDate(excelSerialDate: number) : typeof Date;

type Input = Stream | Buffer | PathLike;

export function readXlsxFile<T extends object>(input: Input, options: ParseWithSchemaOptions<T>) : Promise<ParsedObjectsResult<T>>;
export function readXlsxFile<T extends object>(input: Input, options: ParseWithMapOptions) : Promise<ParsedObjectsResult<T>>;
export function readXlsxFile(input: Input, options?: ParseWithoutSchemaOptions) : Promise<Row[]>;

export function readSheetNames(input: Input) : Promise<string[]>;

export default readXlsxFile;