Chevron DownAPI Reference

Overview

From-v2.3

The @loaders.gl/compression module provides a small selection of lossless, legally unencumbered compression/decompression (aka deflate/inflate) "transforms" that work as plugins for loaders.gl

Compression Formats

FormatIntended usageNotes
zlibgzip(.gz) and Zip(.zip)Essentially the `deflate' method in PKWARE's PKZIP 2.x)
lz4Arrow FeatherOptimized for speed (real-time compression)
ZstandardArrow FeatherOptimized for speed (real-time compression)

Decompression API

The API offers "transforms" that can inflate/deflate data.

TransformsSyncDescription
ZlibDeflateTransformYCompress using Zlib codec
ZlibInflateTransformYDecompress using Zlib codec
LZ4DeflateTransformYCompress using LZ4 codec
LZ4InflateTransformYDecompress using LZ4 codec
ZstdDeflateTransformNCompress using Zstandard codec
ZstdInflateTransformNDecompress using Zstandard codec