Open In App

Node.js zlib.createGzip() Method

Improve
Improve
Like Article
Like
Save
Share
Report

The zlib.createGzip() method is an inbuilt application programming interface of the Zlib module which is used to create a new Gzip object.

Syntax:

zlib.createGzip( options )

Parameters: This method accepts single parameter options which is optional parameter that holds the zlib options.

Return Value: It returns a new Gzip object.

Below examples illustrate the use of zlib.createGzip() method in Node.js:

Example 1:




// Node.js program to demonstrate the     
// createGzip() method
  
// Including zlib and fs module
const zlib = require("zlib");
const fs = require('fs');
  
// Creating readable Stream
const inp = fs.createReadStream('input.txt');
  
// Creating writable stream
const out = fs.createWriteStream('input.txt.gz');
  
// Calling createGzip method
const gzip = zlib.createGzip();
  
// Piping
inp.pipe(gzip).pipe(out);
console.log("Gzip created!");


Output:

Gzip created!

Example 2:




// Node.js program to demonstrate the     
// createGzip() method
  
// Including zlib and fs module
const zlib = require("zlib");
const fs = require('fs');
  
// Creating readable Stream
const inp = fs.createReadStream('input.txt');
  
// Creating writable stream
const out = fs.createWriteStream('input.txt.gz');
  
// Calling createGzip method
const gzip = zlib.createGzip();
  
// Piping
inp.pipe(out).pipe(gzip);
console.log("Gzip created!");


Output:

Error [ERR_STREAM_CANNOT_PIPE]: Cannot pipe, not readable
    at WriteStream.Writable.pipe (_stream_writable.js:243:24)
    at /home/runner/SomberMonumentalCad/index.js:19:15
    at Script.runInContext (vm.js:133:20)
    at Object. (/run_dir/interp.js:156:20)
    at Module._compile (internal/modules/cjs/loader.js:778:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3)

Here, piping is not done in a proper order so, error is thrown.

Reference: https://nodejs.org/api/zlib.html#zlib_zlib_creategzip_options



Last Updated : 12 Oct, 2021
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads