What is zarrita.js?

zarrita is a modular Zarr implementation in TypeScript.

• Zero dependencies (optionally scijs/ndarray)
• Supports v2 or v3 protocols, C & F-order arrays, and diverse data-types
• Runs natively in Node, Browsers, and Deno (ESM)
• Allows flexible storage backends and compression codecs
• Provides rich, in-editor type information via template literal types

Zarr building blocks

zarrita is a collection of ECMAScript modules (ESM). Each module exports independent functions to interact with Zarr entities like stores, arrays, and groups.

The choice of ESM exports over a class-based methods allows for better static analysis by bundlers, enabling unused features in zarrita to be tree-shaken. This design differs from existing implementations of Zarr in JavaScript and allows zarrita to be both minimal and feature complete if necessary.

Project overview

zarrita is broken down into several packages to create and interact with Zarr.

@zarrita/storage

• A collection of useful of storage backends for Zarr.
• Implement your own Readable and (optionally Writable) stores.

@zarrita/core

• Navigate a storage hierarchy and open or create groups and arrays.
• Load individual array chunks on-demand based on their key.

@zarrita/indexing

• Slice and index an array, stitching together one or more chunks.
• Offers an ergonomic API familiar to Zarr/numpy users.

const region = await get(arr, [null, null]);
// {
//   data: Uint16Array([ 1, 2, 3, 4]),
//   shape: [2, 2],
//   stride: [2, 1],
// }

@zarrita/ndarray

• Similar to @zarrita/indexing but returns scijs/ndarray objects.
• Ideal for applications already using or require scijs/ndarray objects.

const region = await get(arr, [null, null]);
// ndarray.NdArray<Uint16Array>