React Native

GZip Create / Extract .gz File

See more Gzip Examples

Demonstrates how to compress a file to create a .gz (GZip) file.

Note: The .gz file format is a compressed file format. It contains a single file. The .gz file format is not an archive format (i.e. it does not contain a collection of files/directories such as with the .zip, .rar, or .tar file formats). GZip is often combined with TAR to create a .tgz (or .tar.gz).

Note: It is possible for a .gz to contain more than one file, but this is very uncommon.

React Native

import { Gzip } from '@chilkat/react-native'

async function chilkatExample() {
  let success = false;

  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const gzip = new Gzip();

  // File-to-file GZip:
  // Compress "hamlet.xml" to create "hamlet.xml.gz";
  success = true;
  try {
    await gzip.compressFileAsync('hamlet.xml', 'hamlet.xml.gz');
  } catch {
    success = false;
  }
  if (!success) {
    console.log(gzip.lastErrorText);
    return;
  }

  // File-to-file ungzip
  // Decompress "hamlet.xml.gz" to create "hamletOut.xml";
  success = true;
  try {
    await gzip.uncompressFileAsync('hamlet.xml.gz', 'hamletOut.xml');
  } catch {
    success = false;
  }
  if (!success) {
    console.log(gzip.lastErrorText);
    return;
  }

  // File-to-string ungzip
  // Decompress the contents of a .gz directly to a string variable:
  // The 2nd argument indicates the charset of the character
  // data after it is decompressed.
  const xmlStr = await gzip.uncompressFileToStringAsync('hamlet.xml.gz', 'utf-8');
  if (!success) {
    console.log(gzip.lastErrorText);
    return;
  }

  console.log(xmlStr);

  // The Chilkat GZip API provides much more flexibility than shown
  // here.  See the reference documentation at 
  // http://www.chilkatsoft.com/refdoc for more information.
}