excelite
v0.1.0
Published
A lightweight Excel file creator for Node.js
Readme
Excelite
A lightweight Excel file creator for Node.js that generates XLSX files without external dependencies.
Features
- Create Excel files with a single sheet
- Support for various data types (string, number, boolean, Date)
- No external dependencies for core functionality
- TypeScript support
- Node.js file system integration
Installation
npm install exceliteUsage
Basic Usage
import { createExcel } from 'excelite';
const sheet = [
['Name', 'Age', 'Job'],
['John Doe', 30, 'Developer'],
['Jane Smith', 25, 'Designer']
];
const excelData = createExcel(sheet);Node.js File System Integration
import { writeExcel, writeExcelSync } from 'excelite/node';
// Asynchronous
await writeExcel('output.xlsx', sheet);
// Synchronous
writeExcelSync('output.xlsx', sheet);API
createExcel(sheet: Sheet): Uint8Array
Creates an Excel file and returns it as a Uint8Array.
Parameters
sheet: A sheet is an array of rows, where each row is an array of cells.- Each cell can be either a primitive value (string, number, boolean, Date) or an object with a
valueproperty.
writeExcel(filepath: string, sheet: Sheet): Promise<void>
Creates an Excel file and saves it to the specified path asynchronously.
writeExcelSync(filepath: string, sheet: Sheet): void
Creates an Excel file and saves it to the specified path synchronously.
Development
Prerequisites
- Node.js 22.14.0 or higher
- npm
Setup
# Install dependencies
npm install
# Build the project
npm run build
# Run tests
npm test
# Run tests with coverage
npm run coverageProject Structure
src/: Source codecreateExcel.ts: Core Excel file creation logicnode.ts: Node.js file system integrationzipwriter.ts: ZIP file creation utilitiescrc32.ts: CRC-32 checksum calculationconstants.ts: Excel file format constants
License
Apache-2.0
