4b701f126ebbef544b2347fbf0e2421c987ff504.svn-base
1.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
Intro
=====
Does deflate compression/decompression in the browser and node.
This module is not meant to be run on node for any production code. The native version of deflate should be used instead because it is much faster. The main reason for this being node-compatible is for testing purposes.
Currently deflate does not pass all tests, but inflate does. This should not be used for compressing data yet in production.
Install
=======
For node, deflate-js can be installed with npm: `npm install deflate-js`
For the browser, deflate-js can be installed with pakmanager.
API
===
Deflate:
> *deflate(arr[, level])*
>
> **arr**- Byte array to compress
>
> **level**- 1-9 (compression level; optional)
Inflate:
> *inflate(arr)*
>
>
> **arr**- Byte array to decompress
The basic usage (no level) will suffice for most purposes.
Basic Usage
-----------
var deflate = require('deflate-js'),
arr;
arr = Array.prototype.map.call('Hello world', function (char) {
return char.charCodeAt(0);
});
// compress some text
var compressed = deflate.deflate(arr);
// decompress some text
var decompressed = deflate.inflate(compressed);