Unzip a Text File Entry into a StringBuilder Using ZipEntry.UnzipToSb

See more Zip Examples

This example demonstrates how to use the ZipEntry.UnzipToSb method to inflate a text file entry directly into a StringBuilder object.

The ZIP entry is uncompressed entirely in memory and appended to the StringBuilder without creating a temporary file on disk.

This is useful when:

• Processing text files directly in memory
• Avoiding temporary filesystem files
• Reading configuration files, JSON, XML, CSV, or source code from ZIP archives
• Automatically converting line endings while inflating the text

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as:

• utf-8
• utf-16
• windows-1252

The lineEndingBehavior argument controls line-ending conversion:

• 0 — Leave line endings unchanged
• 1 — Convert all line endings to bare LF
• 2 — Convert all line endings to CRLF

Suppose the ZIP archive contains:

config/settings.json

The example inflates the JSON file directly into a StringBuilder.

var success = false;

var zip = new CkZip();

// Open an existing ZIP archive.
success = zip.OpenZip("qa_data/zips/configFiles.zip");
if (success == false) {
    console.log(zip.LastErrorText);
    return;
}

// Locate the JSON file entry within the ZIP archive.
var entry = new CkZipEntry();

success = zip.EntryOf("config/settings.json",entry);
if (success == false) {
    console.log("ZIP entry not found.");
    zip.CloseZip();
    return;
}

// ------------------------------------------------------------
// Inflate the ZIP entry directly into a StringBuilder.
// 
// The uncompressed text is appended to the StringBuilder.
// 
var sb = new CkStringBuilder();

// Leave line endings unchanged.
var lineEndingBehavior = 0;

// Interpret the uncompressed bytes as UTF-8 text.
var srcCharset = "utf-8";

success = entry.UnzipToSb(lineEndingBehavior,srcCharset,sb);
if (success == false) {
    console.log(entry.LastErrorText);
    return;
}

console.log("Uncompressed text:");
console.log("");
console.log(sb.GetAsString());

zip.CloseZip();

console.log("Done.");