node-xlsx
- Version 0.24.0
- Published
- 43.1 kB
- 1 dependency
- Apache-2.0 license
Install
npm i node-xlsx
yarn add node-xlsx
pnpm add node-xlsx
Overview
NodeJS Excel files parser & builder
Index
Variables
Functions
Type Aliases
Variables
variable _default
const _default: { parse: <T = any[]>( mixed: unknown, options?: Sheet2JSONOpts & ParsingOptions ) => { name: string; data: T[] }[]; parseMetadata: ( mixed: unknown, options?: ParsingOptions ) => { name: string; data: Range | null }[]; build: ( worksheets: WorkSheet<unknown>[], { parseOptions, writeOptions, sheetOptions, ...otherOptions }?: BuildOptions ) => Buffer;};
Functions
function build
build: ( worksheets: WorkSheet[], { parseOptions, writeOptions, sheetOptions, ...otherOptions }?: BuildOptions) => Buffer;
function parse
parse: <T = any[]>( mixed: unknown, options?: Sheet2JSONOpts & ParsingOptions) => { name: string; data: T[] }[];
function parseMetadata
parseMetadata: ( mixed: unknown, options?: ParsingOptions) => { name: string; data: Range | null }[];
Type Aliases
type BuildOptions
type BuildOptions = WorkSheetOptions & { parseOptions?: AOA2SheetOpts; writeOptions?: WritingOptions; sheetOptions?: WorkSheetOptions;};
type WorkSheet
type WorkSheet<T = unknown> = { name: string; data: T[][]; options: WorkSheetOptions;};
type WorkSheetOptions
type WorkSheetOptions = { /** Column Info */ '!cols'?: ColInfo[]; /** Row Info */ '!rows'?: RowInfo[]; /** Merge Ranges */ '!merges'?: Range[]; /** Worksheet Protection info */ '!protect'?: ProtectInfo; /** AutoFilter info */ '!autofilter'?: AutoFilterInfo;};
Package Files (1)
Dependencies (1)
Dev Dependencies (10)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/node-xlsx
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/node-xlsx)
- HTML<a href="https://www.jsdocs.io/package/node-xlsx"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3558 ms. - Missing or incorrect documentation? Open an issue for this package.