Compression

Compressing and decompressing data streams

nx.js implements the Web Compression Streams API, which allows your application to compress and/or decompress streams of data.

Compression Modes

The supported standardized compression modes are listed in the table below:

Mode	Description
`"deflate"`	Uses the DEFLATE algorithm in ZLIB Compressed Data Format
`"deflate-raw"`	Uses the DEFLATE algorithm, without a header and trailing checksum
`"gzip"`	Uses the GZIP format

The following non-standard / extension compression modes are also supported:

Mode	Description
`"zstd"`	Uses the Zstandard format (useful for decompressing `.ncz` / `.xcz` files)

await Switch.file("sdmc:/file.txt")
    .pipeThrough(new CompressionStream("gzip"))
    .pipeTo(Switch.file("sdmc:/file.txt.gz"));

await Switch.file("sdmc:/file.txt.gz")
    .pipeThrough(new DecompressionStream("gzip"))
    .pipeTo(Switch.file("sdmc:/file.txt"));