Giter Club home page Giter Club logo

gzip-js's Introduction

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);

gzip-js's People

Contributors

beatgammit avatar rhysd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gzip-js's Issues

I'm getting a broken file

I'm getting a weird text.

`
let options = {
level: 3,
name: file.name,
timestamp: 54554545
};
debugger
let test = gzip.zip(file, options);

                var decoded="";

                let testa = test.forEach(ch=>decoded+=(String.fromCharCode(ch)));`
I can't download the file because it's broken:

var saveByteArray = (function () {
var a = document.createElement("a");
document.body.appendChild(a);
return function (data, name) {
var blob = new Blob(data, {type: "octet/stream"}),
url = window.URL.createObjectURL(blob);
a.href = url;
a.download = name;
a.click();
window.URL.revokeObjectURL(url);
};
}());

                saveByteArray([test], 'example.gz');

same here:
`
                    let options = {name: file.name};
                    let test = gzip.zip(file, options);
                    var blob=new Blob([test], {type: "application/gzip"});
                    saveAs(blob)`

Checksum does not match

If I zip a string a string 'hello world' in the browser, upload to a node.js server and call unzip, it throws Checksum does not match.

Am I missing something obvious?

Need all dependent JS files

I am very much impressed with your gzip tool in javascript , but it has a dependency with deflate.js.

can you include all the dependency ( JS files ) in lib folder for gzip project.

Another note ; since we are using pure javascript I don`t have implementation of "require" function.

Looks like [email protected] is not use , all mail are bouncing back to me

Advance thanks
Thx
Vin

Fails on all tests for level <= 3

When the level is <= 3, there is an extra byte in the output of the hello-world test. This could be the key symptom of why this is failing. Also, when level <= 3, there is special handling, so perhaps that is the place to look.

.

.

unzipping

Hi, very nice lib, but I cannot figure out how to unzip it,
when a do gzip.unzip(out) - I get back array of numbers [ 72, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100 ]
how to convert them into letters?
thank you

Can gzip-js be directly used in browser?

Hi!
I saw you described

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

in Readme.md.
But I can not find a way to use it in browser.
Could you please tell me the way how to use it?
Thank you πŸ˜„

For the reference cdnjs/cdnjs#11818

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.