excelite
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

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 excelite

Usage

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 value property.

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 coverage

Project Structure

  • src/: Source code
    • createExcel.ts: Core Excel file creation logic
    • node.ts: Node.js file system integration
    • zipwriter.ts: ZIP file creation utilities
    • crc32.ts: CRC-32 checksum calculation
    • constants.ts: Excel file format constants

License

Apache-2.0

Package Sidebar

Install

npm i excelite

Weekly Downloads

4

Version

0.1.0

License

Apache-2.0

Unpacked Size

31.3 kB

Total Files

15

Last publish

Collaborators

  • taggon