First draft of definition for pako

This commit is contained in:
dencap
2015-11-25 17:23:03 +01:00
parent 1000b2c823
commit 82a3b88cdc
2 changed files with 16 additions and 22 deletions
+5 -14
View File
@@ -2,25 +2,16 @@
import pako = require("pako");
var test = { my: 'super', puper: [456, 567], awesome: 'pako' };
var binaryString = pako.deflate(JSON.stringify(test), { to: 'string' });
//
// Here you can do base64 encode, make xhr requests and so on.
//
var restored = JSON.parse(pako.inflate(binaryString, { to: 'string' }));
var pako = require('pako')
, chunk1 = Uint8Array([1,2,3,4,5,6,7,8,9])
, chunk2 = Uint8Array([10,11,12,13,14,15,16,17,18,19]);
var chunk1 = new Uint8Array([1,2,3,4,5,6,7,8,9])
var chunk2 = new Uint8Array([10,11,12,13,14,15,16,17,18,19]);
var deflate = new pako.Deflate({ level: 3});
deflate.push(chunk1, false);
deflate.push(chunk2, true); // true -> last chunk
if (deflate.err) { throw new Error(deflate.err); }
if (deflate.err) {
throw new Error( deflate.err.toString() );
}
console.log(deflate.result);
+11 -8
View File
@@ -21,20 +21,23 @@ declare module Pako {
* Decompress data with inflate/ungzip and options. Autodetect format via wrapper header
* by default. That's why we don't provide separate ungzip method.
*/
export function inflate( data: Uint8Array | Array<number> | string, options?: any ): Uint8Array | Array<number> | string;
export function inflate( data: Uint8Array | Array<number> | string, options?: any ): Uint8Array;
export function inflate( data: Uint8Array | Array<number> | string, options?: any ): Array<number>;
export function inflate( data: Uint8Array | Array<number> | string, options?: any ): String;
/**
* The same as inflate, but creates raw data, without wrapper (header and adler32 crc).
*/
export function inflateRaw( data: Uint8Array | Array<number> | string, options?: any ): Uint8Array | Array<number> | string;
export function inflateRaw( data: Uint8Array | Array<number> | string, options?: any ): Uint8Array;
export function inflateRaw( data: Uint8Array | Array<number> | string, options?: any ): Array<number>;
export function inflateRaw( data: Uint8Array | Array<number> | string, options?: any ): string;
/**
* Just shortcut to inflate, because it autodetects format by header.content. Done for convenience.
*/
export function ungzip( data: Uint8Array | Array<number> | string, options?: any ): Uint8Array | Array<number> | string;
export function ungzip( data: Uint8Array | Array<number> | string, options?: any ): Uint8Array;
export function ungzip( data: Uint8Array | Array<number> | string, options?: any ): Array<number>;
export function ungzip( data: Uint8Array | Array<number> | string, options?: any ): string;
export interface Deflate {
/**
*
*/
export class Deflate {
constructor( options?: any );
err: number;
msg: string;
@@ -44,7 +47,7 @@ declare module Pako {
push( data: Uint8Array | Array<number> | ArrayBuffer | string, mode?: number | boolean ): boolean;
}
export interface Inflate {
export class Inflate {
constructor( options?: any );
err: number;
msg: string;