read Functions
Functions from src/read.ts
Functions exported from src/read.ts
read
function read(data: any, opts?: FullReadOptions): Promise<WorkBook>Parameters
| Name | Type | Description |
|---|---|---|
| data | any | File contents as Uint8Array, ArrayBuffer, Buffer, base64 string, binary string, or plain text string |
| opts (optional) | FullReadOptions | Read options controlling parsing behavior |
Returns
Promise<WorkBook>
A full workbook, or the metadata-only shape selected by bookSheets and bookProps
function read(data: any, opts: BookSheetsAndPropsReadOptions): Promise<BookSheetsAndPropsResult>Parameters
| Name | Type | Description |
|---|---|---|
| data | any | File contents as Uint8Array, ArrayBuffer, Buffer, base64 string, binary string, or plain text string |
| opts | BookSheetsAndPropsReadOptions | Read options controlling parsing behavior |
Returns
Promise<BookSheetsAndPropsResult>
A full workbook, or the metadata-only shape selected by bookSheets and bookProps
function read(data: any, opts: BookSheetsReadOptions): Promise<BookSheetsResult>Parameters
| Name | Type | Description |
|---|---|---|
| data | any | File contents as Uint8Array, ArrayBuffer, Buffer, base64 string, binary string, or plain text string |
| opts | BookSheetsReadOptions | Read options controlling parsing behavior |
Returns
Promise<BookSheetsResult>
A full workbook, or the metadata-only shape selected by bookSheets and bookProps
function read(data: any, opts: BookPropsReadOptions): Promise<BookPropsResult>Parameters
| Name | Type | Description |
|---|---|---|
| data | any | File contents as Uint8Array, ArrayBuffer, Buffer, base64 string, binary string, or plain text string |
| opts | BookPropsReadOptions | Read options controlling parsing behavior |
Returns
Promise<BookPropsResult>
A full workbook, or the metadata-only shape selected by bookSheets and bookProps
function read(data: any, opts?: ReadOptions): Promise<ReadResult>Parameters
| Name | Type | Description |
|---|---|---|
| data | any | File contents as Uint8Array, ArrayBuffer, Buffer, base64 string, binary string, or plain text string |
| opts (optional) | ReadOptions | Read options controlling parsing behavior |
Returns
Promise<ReadResult>
A full workbook, or the metadata-only shape selected by bookSheets and bookProps