Skip to main content

Editor.Compression.GZip

Class

GZip compression utility for packing and unpacking files.

Index

Example

// Editor.Compression.GZip compresses a single file (use Zip for trees).
// Below: write a real JSON file, gzip it, decompress it back, and
// verify the round-trip matches.
const fs = await import('LensStudio:FileSystem');

const tmp = fs.TempDir.create();
const src = tmp.path.appended(new Editor.Path('report.json'));
const gz = tmp.path.appended(new Editor.Path('report.json.gz'));
const restored = tmp.path.appended(new Editor.Path('report_restored.json'));

const original = JSON.stringify({ generatedAt: Date.now(), entries: 42 });
fs.writeFile(src, original);

Editor.Compression.GZip.pack(src, gz);
Editor.Compression.GZip.unpack(gz, restored);

console.log('round-trip ok:', fs.readFile(restored) === original,
'| compressed:', fs.size(gz), 'B');

Methods

pack()

static pack(srcFile, destFile): void

Compress a source file to a gzipped destination file.

Parameters

ParameterType
srcFilePath
destFilePath

Returns

void


unpack()

static unpack(srcFile, dstFile): void

Decompress a gzipped source file to a destination file.

Parameters

ParameterType
srcFilePath
dstFilePath

Returns

void