You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Jack Lukic 2130e96444 revisions to css guide 12 years ago
..
bin Fixes issue with accidental submodule 12 years ago
lib Fixes issue with accidental submodule 12 years ago
node_modules structure -- grunt watch and upgrade. 12 years ago
test Fixes issue with accidental submodule 12 years ago
.npmignore Fixes issue with accidental submodule 12 years ago
README.md Fixes issue with accidental submodule 12 years ago
package.json structure -- grunt watch and upgrade. 12 years ago

README.md

Intro

gzip-js is a pure JavaScript implementation of the GZIP file format. It uses the DEFLATE algorithm for compressing data.

Please note that since this is a pure JavaScript implementation, it should NOT be used on the server for production code. It also does not comply 100% with the standard, yet.

The main goal of this project is to bring GZIP compression to the browser.

API

There is only one function so far, zip:

function zip(data[, options])

  • data- String of text or byte array to compress
  • options- object with options; options include:
    • level- compression level (1-9); default 6
    • timestamp- UNIX timestamp (seconds); if omitted, the current time will be used
    • name- optional; original name of the file

Sample usage:

var gzip = require('gzip-js'),
    options = {
        level: 3,
        name: 'hello-world.txt',
        timestamp: parseInt(Date.now() / 1000, 10)
    };

// out will be a JavaScript Array of bytes
var out = gzip.zip('Hello world', options);