#file #ts #deno #v8 #esm

eszip

A utility that can download JavaScript and TypeScript module graphs and store them locally in a special zip file

121 releases (breaking)

new 0.89.0 May 23, 2025
0.87.0 Apr 29, 2025
0.83.0 Feb 27, 2025
0.80.0 Dec 17, 2024
0.7.0 Mar 31, 2021

#371 in Parser implementations

Download history 501/week @ 2025-01-31 299/week @ 2025-02-07 329/week @ 2025-02-14 657/week @ 2025-02-21 503/week @ 2025-02-28 709/week @ 2025-03-07 1091/week @ 2025-03-14 1019/week @ 2025-03-21 1222/week @ 2025-03-28 1274/week @ 2025-04-04 1107/week @ 2025-04-11 1393/week @ 2025-04-18 1485/week @ 2025-04-25 1084/week @ 2025-05-02 1671/week @ 2025-05-09 1061/week @ 2025-05-16

5,470 downloads per month
Used in 12 crates (10 directly)

MIT license

190KB
5K SLoC

Rust 4.5K SLoC // 0.0% comments TypeScript 539 SLoC // 0.1% comments TSX 15 SLoC JavaScript 5 SLoC

eszip

The eszip format lets you losslessly serialize an ECMAScript module graph (represented by deno_graph::ModuleGraph) into a single compact file.

The eszip file format is designed to be compact and streaming capable. This allows for efficient loading of large ECMAScript module graphs.

https://eszip-viewer.deno.dev/ is a tool for inspecting eszip files.

Examples

Creating an eszip

cargo run --example eszip_builder https://deno.land/std/http/file_server.ts file_server.eszip2

Viewing the contents of an eszip

cargo run --example eszip_viewer file_server.eszip2

Loading the eszip into V8

cargo run --example eszip_load file_server.eszip2 https://deno.land/std/http/file_server.ts

File format

The file format looks as follows:

Eszip:
| Magic (8) | Header size (4) | Header (n) | Header hash (32) | Sources size (4) | Sources (n) | SourceMaps size (4) | SourceMaps (n) |

Header:
( | Specifier size (4) | Specifier (n) | Entry type (1) | Entry (n) | )*

Entry (redirect):
| Specifier size (4) | Specifier (n) |

Entry (module):
| Source offset (4) | Source size (4) | SourceMap offset (4) | SourceMap size (4) | Module type (1) |

Sources:
( | Source (n) | Hash (32) | )*

SourceMaps:
( | SourceMap (n) | Hash (32) | )*

There is one optimization for empty source / source map entries. If both the offset and size are set to 0, no entry and no hash is present in the data sections for that module.

Development

When opening a PR make sure to rebuild Wasm by running:

deno task build

Dependencies

~26–37MB
~622K SLoC