@cj-tech-master/excelts 1.6.2 → 1.6.3-canary.20251224124621.73c5d94

package/dist/types/doc/row.d.ts

@@ -1,6 +1,6 @@
-import { Cell, type CellModel, type CellAddress } from "./cell.js";
-import type { Worksheet } from "./worksheet.js";
-import type { Style, NumFmt, Font, Alignment, Protection, Borders, Fill, CellValue, RowValues } from "../types.js";
+import { Cell, type CellModel, type CellAddress } from "./cell";
+import type { Worksheet } from "./worksheet";
+import type { Style, NumFmt, Font, Alignment, Protection, Borders, Fill, CellValue, RowValues } from "../types";
 interface RowDimensions {
     min: number;
     max: number;

package/dist/types/doc/table.d.ts

@@ -1,5 +1,5 @@
-import type { Address, CellFormulaValue, CellValue, Style, TableColumnProperties, TableStyleProperties } from "../types.js";
-import type { Worksheet } from "./worksheet.js";
+import type { Address, CellFormulaValue, CellValue, Style, TableColumnProperties, TableStyleProperties } from "../types";
+import type { Worksheet } from "./worksheet";
 interface TableModel {
     ref: string;
     name: string;
@@ -67,8 +67,8 @@ declare class Table {
     set headerRow(value: boolean | undefined);
     get totalsRow(): boolean | undefined;
     set totalsRow(value: boolean | undefined);
-    get theme(): string | undefined;
-    set theme(value: string | undefined);
+    get theme(): TableStyleProperties["theme"];
+    set theme(value: TableStyleProperties["theme"]);
     get showFirstColumn(): boolean | undefined;
     set showFirstColumn(value: boolean | undefined);
     get showLastColumn(): boolean | undefined;

package/dist/types/doc/workbook.base.d.ts

@@ -0,0 +1,111 @@
+/**
+ * WorkbookBase - Platform-independent base class for Workbook
+ *
+ * This file contains all the shared logic between Node.js and Browser versions.
+ * Platform-specific features (xlsx, csv, streaming) are added by subclasses.
+ */
+import { Worksheet, type WorksheetModel } from "./worksheet";
+import { DefinedNames, type DefinedNameModel } from "./defined-names";
+import type { PivotTable } from "./pivot-table";
+import type { AddWorksheetOptions, CalculationProperties, Image, WorkbookProperties, WorkbookView, Buffer as ExcelBuffer } from "../types";
+/** Internal media type - more flexible than public Media type */
+export interface WorkbookMedia {
+    type: string;
+    extension: string;
+    filename?: string;
+    buffer?: ExcelBuffer | Uint8Array;
+    base64?: string;
+    name?: string;
+}
+/** Internal model type for serialization */
+export interface WorkbookModel {
+    creator?: string;
+    lastModifiedBy?: string;
+    lastPrinted?: Date;
+    created: Date;
+    modified: Date;
+    properties: Partial<WorkbookProperties>;
+    worksheets: WorksheetModel[];
+    sheets?: WorksheetModel[];
+    definedNames: DefinedNameModel[];
+    views: WorkbookView[];
+    company: string;
+    manager: string;
+    title: string;
+    subject: string;
+    keywords: string;
+    category: string;
+    description: string;
+    language?: string;
+    revision?: number;
+    contentStatus?: string;
+    themes?: unknown;
+    media: WorkbookMedia[];
+    pivotTables: PivotTable[];
+    /** Loaded pivot tables from file - used during reconciliation */
+    loadedPivotTables?: any[];
+    calcProperties: Partial<CalculationProperties>;
+}
+/**
+ * Base class for Workbook containing all platform-independent functionality.
+ *
+ * Subclasses add:
+ * - Node.js: xlsx (full), csv, streaming (createStreamWriter/Reader)
+ * - Browser: xlsx (buffer only), no csv, no streaming
+ */
+export declare abstract class WorkbookBase {
+    category: string;
+    company: string;
+    created: Date;
+    description: string;
+    keywords: string;
+    manager: string;
+    modified: Date;
+    subject: string;
+    title: string;
+    creator?: string;
+    lastModifiedBy?: string;
+    lastPrinted?: Date;
+    language?: string;
+    revision?: number;
+    contentStatus?: string;
+    properties: Partial<WorkbookProperties>;
+    calcProperties: Partial<CalculationProperties>;
+    views: WorkbookView[];
+    media: WorkbookMedia[];
+    pivotTables: PivotTable[];
+    protected _worksheets: Worksheet[];
+    protected _definedNames: DefinedNames;
+    protected _themes?: unknown;
+    constructor();
+    get nextId(): number;
+    /**
+     * Add a new worksheet and return a reference to it
+     */
+    addWorksheet(name?: string, options?: AddWorksheetOptions): Worksheet;
+    removeWorksheetEx(worksheet: Worksheet): void;
+    removeWorksheet(id: number | string): void;
+    /**
+     * Fetch sheet by name or id
+     */
+    getWorksheet(id?: number | string): Worksheet | undefined;
+    /**
+     * Return a clone of worksheets in order
+     */
+    get worksheets(): Worksheet[];
+    /**
+     * Iterate over all sheets.
+     *
+     * Note: `workbook.worksheets.forEach` will still work but this is better.
+     */
+    eachSheet(callback: (sheet: Worksheet, id: number) => void): void;
+    get definedNames(): DefinedNames;
+    clearThemes(): void;
+    /**
+     * Add Image to Workbook and return the id
+     */
+    addImage(image: Image): number;
+    getImage(id: number | string): WorkbookMedia | undefined;
+    get model(): WorkbookModel;
+    set model(value: WorkbookModel);
+}

package/dist/types/doc/workbook.browser.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Workbook Browser version - No Node.js dependencies
+ *
+ * Extends WorkbookBase with:
+ * - xlsx: Buffer-based operations (load, writeBuffer)
+ * - csv: Buffer-based operations (load, writeString, writeBuffer)
+ * - streaming: NOT supported (throws error)
+ */
+import { WorkbookBase } from "./workbook.base";
+import { XLSX } from "../xlsx/xlsx.browser";
+import { CSV } from "../csv/csv.browser";
+declare class Workbook extends WorkbookBase {
+    private _xlsx?;
+    private _csv?;
+    /**
+     * xlsx file format operations
+     * Supports: load (buffer), writeBuffer
+     * NOT supported: readFile, writeFile, read (stream), write (stream)
+     */
+    get xlsx(): XLSX;
+    /**
+     * CSV file format operations
+     * Supports: load (string/buffer), writeString, writeBuffer
+     * NOT supported: readFile, writeFile, read (stream), write (stream)
+     */
+    get csv(): CSV;
+    /**
+     * @deprecated Streaming is not available in browser
+     * @throws Error with helpful message
+     */
+    static createStreamWriter(_options?: unknown): never;
+    /**
+     * @deprecated Streaming is not available in browser
+     * @throws Error with helpful message
+     */
+    static createStreamReader(_input?: unknown, _options?: unknown): never;
+}
+export { Workbook };

package/dist/types/doc/workbook.d.ts

@@ -1,109 +1,79 @@
-import { Worksheet, type WorksheetModel } from "./worksheet.js";
-import { DefinedNames, type DefinedNameModel } from "./defined-names.js";
-import { XLSX } from "../xlsx/xlsx.js";
-import { CSV } from "../csv/csv.js";
-import type { PivotTable } from "./pivot-table.js";
-import type { AddWorksheetOptions, CalculationProperties, Image, WorkbookProperties, WorkbookView, Buffer as ExcelBuffer } from "../types.js";
-interface WorkbookMedia {
-    type: string;
-    extension: string;
-    filename?: string;
-    buffer?: ExcelBuffer;
-    base64?: string;
-    name?: string;
-}
-interface WorkbookModel {
-    creator?: string;
-    lastModifiedBy?: string;
-    lastPrinted?: Date;
-    created: Date;
-    modified: Date;
-    properties: Partial<WorkbookProperties>;
-    worksheets: WorksheetModel[];
-    sheets?: WorksheetModel[];
-    definedNames: DefinedNameModel[];
-    views: WorkbookView[];
-    company: string;
-    manager: string;
-    title: string;
-    subject: string;
-    keywords: string;
-    category: string;
-    description: string;
-    language?: string;
-    revision?: number;
-    contentStatus?: string;
-    themes?: unknown;
-    media: WorkbookMedia[];
-    pivotTables: PivotTable[];
-    /** Loaded pivot tables from file - used during reconciliation */
-    loadedPivotTables?: any[];
-    calcProperties: Partial<CalculationProperties>;
-}
-declare class Workbook {
-    category: string;
-    company: string;
-    created: Date;
-    description: string;
-    keywords: string;
-    manager: string;
-    modified: Date;
-    properties: Partial<WorkbookProperties>;
-    calcProperties: Partial<CalculationProperties>;
-    private _worksheets;
-    subject: string;
-    title: string;
-    views: WorkbookView[];
-    media: WorkbookMedia[];
-    pivotTables: PivotTable[];
-    private _definedNames;
-    creator?: string;
-    lastModifiedBy?: string;
-    lastPrinted?: Date;
-    language?: string;
-    revision?: number;
-    contentStatus?: string;
-    private _themes?;
+/**
+ * Workbook - Node.js version with full functionality
+ *
+ * Extends WorkbookBase with:
+ * - xlsx: Full file/stream/buffer support
+ * - csv: CSV read/write support
+ * - streaming: createStreamWriter/createStreamReader for large files
+ */
+import { WorkbookBase } from "./workbook.base";
+import { XLSX } from "../xlsx/xlsx";
+import { CSV } from "../csv/csv";
+import { WorkbookWriter, type WorkbookWriterOptions } from "../stream/xlsx/workbook-writer";
+import { WorkbookReader, type WorkbookReaderOptions } from "../stream/xlsx/workbook-reader";
+import type { Readable } from "stream";
+declare class Workbook extends WorkbookBase {
+    /**
+     * Streaming workbook writer class for large files.
+     * @example new Workbook.Writer({ filename: "large.xlsx" })
+     */
+    static Writer: typeof WorkbookWriter;
+    /**
+     * Streaming workbook reader class for large files.
+     * @example new Workbook.Reader("large.xlsx")
+     */
+    static Reader: typeof WorkbookReader;
     private _xlsx?;
     private _csv?;
-    constructor();
     /**
      * xlsx file format operations
+     * Supports: readFile, writeFile, read (stream), write (stream), load (buffer), writeBuffer
      */
     get xlsx(): XLSX;
     /**
      * csv file format operations
+     * Supports: readFile, writeFile, read (stream), write (stream)
      */
     get csv(): CSV;
-    get nextId(): number;
-    /**
-     * Add a new worksheet and return a reference to it
-     */
-    addWorksheet(name?: string, options?: AddWorksheetOptions): Worksheet;
-    removeWorksheetEx(worksheet: Worksheet): void;
-    removeWorksheet(id: number | string): void;
     /**
-     * Fetch sheet by name or id
-     */
-    getWorksheet(id?: number | string): Worksheet | undefined;
-    /**
-     * Return a clone of worksheets in order
-     */
-    get worksheets(): Worksheet[];
-    /**
-     * Iterate over all sheets.
+     * Create a streaming workbook writer for large files.
+     * This is more memory-efficient than using Workbook for large datasets.
      *
-     * Note: `workbook.worksheets.forEach` will still work but this is better.
+     * @param options - Options for the workbook writer
+     * @returns A new WorkbookWriter instance
+     *
+     * @example
+     * ```ts
+     * const writer = Workbook.createStreamWriter({ filename: "large-file.xlsx" });
+     * const sheet = writer.addWorksheet("Sheet1");
+     * for (let i = 0; i < 1000000; i++) {
+     *   sheet.addRow([i, `Row ${i}`]).commit();
+     * }
+     * await writer.commit();
+     * ```
      */
-    eachSheet(callback: (sheet: Worksheet, id: number) => void): void;
-    get definedNames(): DefinedNames;
-    clearThemes(): void;
+    static createStreamWriter(options?: WorkbookWriterOptions): WorkbookWriter;
     /**
-     * Add Image to Workbook and return the id
+     * Create a streaming workbook reader for large files.
+     * This is more memory-efficient than using Workbook.xlsx.readFile for large datasets.
+     *
+     * @param input - File path or readable stream
+     * @param options - Options for the workbook reader
+     * @returns A new WorkbookReader instance
+     *
+     * @example
+     * ```ts
+     * const reader = Workbook.createStreamReader("large-file.xlsx");
+     * for await (const event of reader) {
+     *   if (event.eventType === "worksheet") {
+     *     const worksheet = event.value;
+     *     for await (const row of worksheet) {
+     *       console.log(row.values);
+     *     }
+     *   }
+     * }
+     * ```
      */
-    addImage(image: Image): number;
-    getImage(id: number | string): WorkbookMedia | undefined;
-    get model(): WorkbookModel;
-    set model(value: WorkbookModel);
+    static createStreamReader(input: string | Readable, options?: WorkbookReaderOptions): WorkbookReader;
 }
 export { Workbook };

package/dist/types/doc/worksheet.d.ts

@@ -1,13 +1,13 @@
-import { Range, type RangeInput } from "./range.js";
-import { Row, type RowModel } from "./row.js";
-import { Column, type ColumnModel, type ColumnDefn } from "./column.js";
-import type { Cell, FormulaResult } from "./cell.js";
-import { Image, type ImageModel } from "./image.js";
-import { Table, type TableModel } from "./table.js";
-import { DataValidations } from "./data-validations.js";
-import { type PivotTable, type PivotTableModel } from "./pivot-table.js";
-import type { Workbook } from "./workbook.js";
-import type { AddImageRange, AutoFilter, CellValue, ConditionalFormattingOptions, DataValidation, RowBreak, RowValues, TableProperties, WorksheetProperties, WorksheetView } from "../types.js";
+import { Range, type RangeInput } from "./range";
+import { Row, type RowModel } from "./row";
+import { Column, type ColumnModel, type ColumnDefn } from "./column";
+import type { Cell, FormulaResult } from "./cell";
+import { Image, type ImageModel } from "./image";
+import { Table, type TableModel } from "./table";
+import { DataValidations } from "./data-validations";
+import { type PivotTable, type PivotTableModel } from "./pivot-table";
+import type { Workbook } from "./workbook";
+import type { AddImageRange, AutoFilter, CellValue, ConditionalFormattingOptions, DataValidation, RowBreak, RowValues, TableProperties, WorksheetProperties, WorksheetView } from "../types";
 type DataValidationModel = {
     [address: string]: DataValidation | undefined;
 };

package/dist/types/index.browser.d.ts

@@ -1,5 +1,19 @@
-export { Workbook } from "./doc/workbook.js";
-export * from "./doc/enums.js";
-export * from "./types.js";
-export * from "./utils/sheet-utils.js";
-export type { FastCsvParserOptionsArgs, FastCsvFormatterOptionsArgs, CsvReadOptions, CsvWriteOptions } from "./csv/csv.js";
+/**
+ * Browser entry point - No Node.js dependencies
+ * This version is optimized for browser environments with minimal bundle size
+ */
+export { Workbook } from "./doc/workbook.browser";
+export { Worksheet } from "./doc/worksheet";
+export { Row } from "./doc/row";
+export { Column } from "./doc/column";
+export { Cell } from "./doc/cell";
+export { Range } from "./doc/range";
+export { Image } from "./doc/image";
+export * from "./doc/anchor";
+export { Table } from "./doc/table";
+export { DataValidations } from "./doc/data-validations";
+export * from "./doc/enums";
+export * from "./types";
+export type { PivotTable, PivotTableModel, PivotTableSource, CacheField, DataField, PivotTableSubtotal, ParsedCacheDefinition, ParsedCacheRecords } from "./doc/pivot-table";
+export * from "./utils/sheet-utils";
+export type { CsvReadOptions, CsvWriteOptions } from "./csv/csv";

package/dist/types/index.d.ts

@@ -1,20 +1,24 @@
-export { Workbook } from "./doc/workbook.js";
-export { ModelContainer } from "./doc/modelcontainer.js";
-export { WorkbookWriter } from "./stream/xlsx/workbook-writer.js";
-export { WorkbookReader } from "./stream/xlsx/workbook-reader.js";
-export { Worksheet } from "./doc/worksheet.js";
-export { WorksheetReader } from "./stream/xlsx/worksheet-reader.js";
-export { WorksheetWriter } from "./stream/xlsx/worksheet-writer.js";
-export { Row } from "./doc/row.js";
-export { Column } from "./doc/column.js";
-export { Cell } from "./doc/cell.js";
-export { Range } from "./doc/range.js";
-export { Image } from "./doc/image.js";
-export * from "./doc/anchor.js";
-export { Table } from "./doc/table.js";
-export { DataValidations } from "./doc/data-validations.js";
-export type { PivotTable, PivotTableModel, PivotTableSource, CacheField, DataField, PivotTableSubtotal, ParsedCacheDefinition, ParsedCacheRecords } from "./doc/pivot-table.js";
-export * from "./doc/enums.js";
-export * from "./types.js";
-export * from "./utils/sheet-utils.js";
-export type { FastCsvParserOptionsArgs, FastCsvFormatterOptionsArgs, CsvReadOptions, CsvWriteOptions } from "./csv/csv.js";
+export { Workbook } from "./doc/workbook";
+export { Worksheet } from "./doc/worksheet";
+export { Row } from "./doc/row";
+export { Column } from "./doc/column";
+export { Cell } from "./doc/cell";
+export { Range } from "./doc/range";
+export { Image } from "./doc/image";
+export * from "./doc/anchor";
+export { Table } from "./doc/table";
+export { DataValidations } from "./doc/data-validations";
+export { WorkbookWriter } from "./stream/xlsx/workbook-writer";
+export { WorkbookReader } from "./stream/xlsx/workbook-reader";
+export { WorksheetWriter } from "./stream/xlsx/worksheet-writer";
+export { WorksheetReader } from "./stream/xlsx/worksheet-reader";
+export { ModelContainer } from "./doc/modelcontainer";
+export * from "./doc/enums";
+export * from "./types";
+export type { PivotTable, PivotTableModel, PivotTableSource, CacheField, DataField, PivotTableSubtotal, ParsedCacheDefinition, ParsedCacheRecords } from "./doc/pivot-table";
+export type { WorkbookReaderOptions, ParseEvent, SharedStringEvent, WorksheetReadyEvent, HyperlinksEvent } from "./stream/xlsx/workbook-reader";
+export type { WorksheetReaderOptions, WorksheetEvent, RowEvent, HyperlinkEvent, WorksheetHyperlink } from "./stream/xlsx/worksheet-reader";
+export type { WorkbookWriterOptions, ZipOptions, ZlibOptions } from "./stream/xlsx/workbook-writer";
+export type { CsvReadOptions, CsvWriteOptions, CsvStreamReadOptions, CsvStreamWriteOptions } from "./csv/csv";
+export { CsvParserStream, CsvFormatterStream } from "./csv/csv";
+export * from "./utils/sheet-utils";

package/dist/types/local.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/stream/xlsx/hyperlink-reader.d.ts

@@ -1,24 +1,24 @@
 import { EventEmitter } from "events";
-interface HyperlinkReaderOptions {
-    workbook: any;
+import type { WorkbookReader, InternalWorksheetOptions } from "./workbook-reader";
+export interface HyperlinkReaderOptions {
+    workbook: WorkbookReader;
     id: number;
-    iterator: any;
-    options: any;
+    iterator: AsyncIterable<unknown>;
+    options: InternalWorksheetOptions;
 }
-interface Hyperlink {
+/** Hyperlink relationship parsed from worksheet rels */
+export interface Hyperlink {
     type: number;
     rId: string;
     target: string;
     targetMode: string;
 }
 declare class HyperlinkReader extends EventEmitter {
-    workbook: any;
+    workbook: WorkbookReader;
     id: number;
-    iterator: any;
-    options: any;
-    hyperlinks?: {
-        [key: string]: Hyperlink;
-    };
+    iterator: AsyncIterable<unknown>;
+    options: InternalWorksheetOptions;
+    hyperlinks?: Record<string, Hyperlink>;
     constructor({ workbook, id, iterator, options }: HyperlinkReaderOptions);
     get count(): number;
     each(fn: (hyperlink: Hyperlink, rId: string) => void): void;

package/dist/types/stream/xlsx/workbook-reader.d.ts

@@ -1,44 +1,133 @@
 import { EventEmitter } from "events";
-interface WorkbookReaderOptions {
-    worksheets?: string;
-    sharedStrings?: string;
-    hyperlinks?: string;
-    styles?: string;
-    entries?: string;
+import { Readable } from "stream";
+import { StylesXform } from "../../xlsx/xform/style/styles-xform";
+import { WorksheetReader } from "./worksheet-reader";
+import { HyperlinkReader } from "./hyperlink-reader";
+import type { WorksheetState, Font, WorkbookProperties } from "../../types";
+/** Internal options type that includes undocumented 'prep' value */
+export interface InternalWorksheetOptions {
+    worksheets?: "emit" | "ignore" | "prep";
+    sharedStrings?: "cache" | "emit" | "ignore";
+    hyperlinks?: "cache" | "emit" | "ignore";
+    styles?: "cache" | "ignore";
+    entries?: "emit" | "ignore";
 }
-declare class WorkbookReader extends EventEmitter {
-    input: any;
-    options: WorkbookReaderOptions;
-    styles: any;
-    stream?: any;
-    sharedStrings?: any[];
-    workbookRels?: any[];
-    properties?: any;
-    model?: any;
-    constructor(input: any, options?: WorkbookReaderOptions);
-    _getStream(input: any): any;
-    read(input?: any, options?: WorkbookReaderOptions): Promise<void>;
-    [Symbol.asyncIterator](): AsyncIterableIterator<any>;
-    parse(input?: any, options?: WorkbookReaderOptions): AsyncIterableIterator<{
-        eventType: string;
-        value: any;
+/** Rich text item from shared strings */
+export interface SharedStringRichText {
+    richText: Array<{
+        font: Partial<Font> | null;
+        text: string | null;
     }>;
-    _emitEntry(payload: any): void;
-    _parseRels(entry: any): Promise<void>;
-    _parseWorkbook(entry: any): Promise<void>;
-    _parseSharedStrings(entry: any): AsyncIterableIterator<{
+}
+/** Shared string value - either plain text or rich text */
+export type SharedStringValue = string | SharedStringRichText;
+/** Relationship entry from workbook.xml.rels */
+export interface WorkbookRelationship {
+    Id: string;
+    Target: string;
+    Type?: string;
+}
+/** Sheet metadata from workbook.xml */
+export interface SheetMetadata {
+    id: number;
+    name: string;
+    state?: WorksheetState;
+    rId: string;
+}
+/** Workbook model parsed from workbook.xml */
+export interface WorkbookModel {
+    sheets?: SheetMetadata[];
+    properties?: Partial<WorkbookProperties>;
+    views?: unknown[];
+    definedNames?: unknown[];
+}
+/** Properties parsed from workbook.xml (workbookPr element) */
+export interface WorkbookPropertiesXform {
+    model?: Partial<WorkbookProperties>;
+}
+/** Entry event payload */
+interface EntryPayload {
+    type: "shared-strings" | "styles" | "workbook" | "worksheet" | "hyperlinks";
+    id?: string;
+}
+/** Parse event types */
+export type ParseEventType = "shared-strings" | "worksheet" | "hyperlinks";
+export interface SharedStringEvent {
+    eventType: "shared-strings";
+    value: {
         index: number;
-        text: any;
-    }>;
-    _parseStyles(entry: any): Promise<void>;
-    _parseWorksheet(iterator: any, sheetNo: string): IterableIterator<{
-        eventType: string;
-        value: any;
-    }>;
-    _parseHyperlinks(iterator: any, sheetNo: string): IterableIterator<{
-        eventType: string;
-        value: any;
+        text: SharedStringValue;
+    };
+}
+export interface WorksheetReadyEvent {
+    eventType: "worksheet";
+    value: WorksheetReader;
+}
+export interface HyperlinksEvent {
+    eventType: "hyperlinks";
+    value: HyperlinkReader;
+}
+export type ParseEvent = SharedStringEvent | WorksheetReadyEvent | HyperlinksEvent;
+/**
+ * Options for WorkbookReader
+ */
+export interface WorkbookReaderOptions {
+    /**
+     * Specifies whether to emit worksheets ('emit') or not ('ignore').
+     * @default 'emit'
+     */
+    worksheets?: "emit" | "ignore";
+    /**
+     * Specifies whether to cache shared strings ('cache'), emit them ('emit'), or ignore them ('ignore').
+     * @default 'cache'
+     */
+    sharedStrings?: "cache" | "emit" | "ignore";
+    /**
+     * Specifies whether to cache hyperlinks ('cache'), emit them ('emit'), or ignore them ('ignore').
+     * @default 'ignore'
+     */
+    hyperlinks?: "cache" | "emit" | "ignore";
+    /**
+     * Specifies whether to cache styles ('cache') or ignore them ('ignore').
+     * @default 'ignore'
+     */
+    styles?: "cache" | "ignore";
+    /**
+     * Specifies whether to emit entries ('emit') or not ('ignore').
+     * @default 'ignore'
+     */
+    entries?: "emit" | "ignore";
+}
+declare class WorkbookReader extends EventEmitter {
+    input: string | Readable;
+    options: {
+        worksheets: "emit" | "ignore";
+        sharedStrings: "cache" | "emit" | "ignore";
+        hyperlinks: "cache" | "emit" | "ignore";
+        styles: "cache" | "ignore";
+        entries: "emit" | "ignore";
+    };
+    styles: StylesXform;
+    stream?: Readable;
+    sharedStrings?: SharedStringValue[];
+    workbookRels?: WorkbookRelationship[];
+    properties?: WorkbookPropertiesXform;
+    model?: WorkbookModel;
+    constructor(input: string | Readable, options?: WorkbookReaderOptions);
+    _getStream(input: string | Readable): Readable;
+    read(input?: string | Readable, options?: WorkbookReaderOptions): Promise<void>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<WorksheetReader>;
+    parse(input?: string | Readable, options?: WorkbookReaderOptions): AsyncIterableIterator<ParseEvent>;
+    _emitEntry(payload: EntryPayload): void;
+    _parseRels(entry: NodeJS.ReadableStream): Promise<void>;
+    _parseWorkbook(entry: NodeJS.ReadableStream): Promise<void>;
+    _parseSharedStrings(entry: NodeJS.ReadableStream): AsyncIterableIterator<{
+        index: number;
+        text: SharedStringValue;
     }>;
+    _parseStyles(entry: NodeJS.ReadableStream): Promise<void>;
+    _parseWorksheet(iterator: AsyncIterable<unknown>, sheetNo: string): IterableIterator<WorksheetReadyEvent>;
+    _parseHyperlinks(iterator: AsyncIterable<unknown>, sheetNo: string): IterableIterator<HyperlinksEvent>;
 }
 declare const WorkbookReaderOptions: {
     readonly worksheets: readonly ["emit", "ignore"];