# Hypaxel documentation

> Hypaxel writes XLSX files as a constant-memory stream in .NET, Rust, Python, Node.js, browsers, Go, Java and PHP, and reads them in five. Start here.

Source: https://hypaxel.libs.vensas.de/docs  
Last updated: 2026-11-20

Hypaxel is a streaming Excel (`.xlsx`) writer by vensas GmbH, available for .NET, Rust, Python, Node.js, browsers (WebAssembly), Go, Java and PHP, with streaming readers for .NET, Rust, Python, Go and Java. It is built for web services and batch jobs that export large tables: memory stays flat whether you write 10 rows or 10 million, and the first bytes of the file reach the HTTP client while your database query is still running.

The current version is 0.3.0 (unreleased). None of the packages is published to a registry yet; see [Getting started](https://hypaxel.libs.vensas.de/docs/getting-started) for the status per language.

## How it works

Hypaxel writes a workbook as a forward-only stream. Each cell is serialized to UTF-8 XML the moment it is written and compressed straight into a small buffer. When the buffer fills, it is flushed to the destination: a file, an HTTP response body, a socket or any other writable stream. Nothing is kept for rows that have already been written.

```text
 rows ──▶ ▓▓▓ UTF-8 XML ──▶ ▒▒▒ deflate ──▶ ░░░ small buffer ──▶ HTTP response / file
          one cell at a time                 flushed as it fills
```

This design has a few consequences you should know before you start:

- Rows are written top to bottom and cells left to right.
- One worksheet is open at a time. Adding the next worksheet completes the previous one.
- Column widths, frozen panes and the row outline depth are set when the worksheet is created, because they come before the cell data in the file.
- Formulas are stored without cached results. Excel recalculates them when the file opens.

The destination does not need to be seekable, so a workbook can be written directly into a non-seekable response stream.

## What you can write

- **Values:** strings, numbers, booleans, dates, times and durations (1900 and 1904 date systems), formulas and styled blank cells.
- **Styles:** fonts, fills, borders, alignment and number formats. Identical styles are de-duplicated.
- **Worksheets:** multiple sheets, column widths, auto-fit columns, row heights, row grouping (outline levels), frozen panes, merged cells, auto filters, Excel tables, hidden sheets and tab colors.
- **Strings:** inline (the default, constant memory) or a shared string table.
- **Valid output:** checked against the Office Open XML schema validator and read back by independent readers (Open XML SDK, calamine, openpyxl, LibreOffice).

## What you can read

The readers in .NET, Rust, Python, Go and Java stream rows the same way the writers do, with memory bounded by the workbook's shared strings plus one row. Node.js and PHP do not read yet.

- **Values:** strings, numbers, booleans and errors, plus dates, times and durations recognised from number formats, in both date systems.
- **Workbooks:** the sheet list with visibility; files from Excel, LibreOffice and other producers, including Strict Open XML.
- **Safety:** clear errors for legacy `.xls`, encrypted and damaged files, and limits for untrusted input.

Each implementation has its own dependency-free parser with the same semantics. Editing existing files (read-modify-write for templates) is on the roadmap.

## Implementations

All implementations share one design. .NET, Rust, Go, Java and PHP are independent native engines with no runtime dependencies. The Python and Node.js packages are thin, idiomatic layers over the Rust core. The Node.js package also runs in browsers, on the Rust core compiled to WebAssembly.

| Language | Package | Runs on | Engine | Web integration | Reads |
| --- | --- | --- | --- | --- | --- |
| [.NET](https://hypaxel.libs.vensas.de/docs/dotnet) | `Hypaxel`, `Hypaxel.AspNetCore` | .NET 8, 9, 10, 11 | native | ASP.NET Core: `Results.Extensions.Excel(...)`, `this.Excel(...)` | yes |
| [Rust](https://hypaxel.libs.vensas.de/docs/rust) | `hypaxel`, `hypaxel-axum` | Rust 1.85+ | native | axum: `Xlsx::from_records(...)`, `Xlsx::from_stream(...)` | yes |
| [Python](https://hypaxel.libs.vensas.de/docs/python) | `hypaxel` | CPython 3.10+ | Rust core (PyO3) | FastAPI/Starlette `XlsxResponse`, Django, Flask | yes |
| [Node.js](https://hypaxel.libs.vensas.de/docs/nodejs) | `hypaxel` | Node.js 22+ | Rust core (napi-rs) | `stream()` for Express, Fastify, Koa; `webStream()` for Next.js, Hono | not yet |
| [Browsers](https://hypaxel.libs.vensas.de/docs/nodejs#browsers) | `hypaxel` | Chrome/Edge 96+, Firefox 79+, Safari 15+ | Rust core (WebAssembly) | `toBlob()` for downloads, `webStream()` | not yet |
| [Go](https://hypaxel.libs.vensas.de/docs/go) | `github.com/vensas/hypaxel/go` | Go 1.26+ | native | `hypaxelhttp.Handler`, `hypaxelhttp.Serve` | yes |
| [Java](https://hypaxel.libs.vensas.de/docs/java) | `de.vensas:hypaxel` | Java 17+ | native | any `OutputStream`: Servlet, Spring `StreamingResponseBody` | yes |
| [PHP](https://hypaxel.libs.vensas.de/docs/php) | `vensas/hypaxel` | PHP 8.2+ | native | `Xlsx::download()`, Symfony `StreamedResponse`, Laravel `streamDownload()` | not yet |

## Where to go next

- [Getting started](https://hypaxel.libs.vensas.de/docs/getting-started): pick your language, write a first workbook and stream one as an HTTP download.
- Reading: [.NET](https://hypaxel.libs.vensas.de/docs/dotnet#reading), [Rust](https://hypaxel.libs.vensas.de/docs/rust#reading), [Python](https://hypaxel.libs.vensas.de/docs/python#reading), [Go](https://hypaxel.libs.vensas.de/docs/go#reading), [Java](https://hypaxel.libs.vensas.de/docs/java#reading).
- Language guides: [.NET](https://hypaxel.libs.vensas.de/docs/dotnet), [Rust](https://hypaxel.libs.vensas.de/docs/rust), [Python](https://hypaxel.libs.vensas.de/docs/python), [Node.js](https://hypaxel.libs.vensas.de/docs/nodejs), [Go](https://hypaxel.libs.vensas.de/docs/go), [Java](https://hypaxel.libs.vensas.de/docs/java), [PHP](https://hypaxel.libs.vensas.de/docs/php).
- [API reference](https://hypaxel.libs.vensas.de/docs/api): the same concepts mapped across all seven languages.
- [Examples](https://hypaxel.libs.vensas.de/docs/examples): file exports, HTTP downloads, object mapping, styled reports, tables and grouping.
- [Performance](https://hypaxel.libs.vensas.de/docs/performance): how the benchmarks were run and why writing and reading are fast. Results are on [Benchmarks](https://hypaxel.libs.vensas.de/benchmarks).
- [Troubleshooting](https://hypaxel.libs.vensas.de/docs/troubleshooting): known limits and how to work with them.

Hypaxel is licensed under the Apache License 2.0, Copyright 2026 vensas GmbH. See [Licensing](https://hypaxel.libs.vensas.de/licensing) and the [Changelog](https://hypaxel.libs.vensas.de/changelog).
