with namespace

This commit is contained in:
Muhammet Ozturk
2019-03-21 06:22:29 +03:00
parent 7dc49fe63c
commit d34d93bb57
2 changed files with 138 additions and 133 deletions
+137 -132
View File
@@ -5,136 +5,141 @@
// Muhammet Öztürk <https://github.com/hlthi>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
export enum FlushValues {
Z_NO_FLUSH = 0,
Z_PARTIAL_FLUSH = 1,
Z_SYNC_FLUSH = 2,
Z_FULL_FLUSH = 3,
Z_FINISH = 4,
Z_BLOCK = 5,
Z_TREES = 6,
}
export enum StrategyValues {
Z_FILTERED = 1,
Z_HUFFMAN_ONLY = 2,
Z_RLE = 3,
Z_FIXED = 4,
Z_DEFAULT_STRATEGY = 0,
}
export enum ReturnCodes {
Z_OK = 0,
Z_STREAM_END = 1,
Z_NEED_DICT = 2,
Z_ERRNO = -1,
Z_STREAM_ERROR = -2,
Z_DATA_ERROR = -3,
Z_BUF_ERROR = -5,
}
export interface DeflateOptions {
level?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
windowBits?: number;
memLevel?: number;
strategy?: StrategyValues;
dictionary?: any;
raw?: boolean;
to?: 'string';
chunkSize?: number;
gzip?: boolean;
header?: Header;
}
export interface DeflateFunctionOptions {
level?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
windowBits?: number;
memLevel?: number;
strategy?: StrategyValues;
dictionary?: any;
raw?: boolean;
to?: 'string';
}
export interface InflateOptions {
windowBits?: number;
dictionary?: any;
raw?: boolean;
to?: 'string';
chunkSize?: number;
}
export interface InflateFunctionOptions {
windowBits?: number;
raw?: boolean;
to?: 'string';
}
export interface Header {
text?: boolean;
time?: number;
os?: number;
extra?: number[];
name?: string;
comment?: string;
hcrc?: boolean;
}
export type Data = Uint8Array | number[] | string;
/**
* Compress data with deflate algorithm and options.
*/
export function deflate(data: Data, options: DeflateFunctionOptions & { to: 'string' }): string;
export function deflate(data: Data, options?: DeflateFunctionOptions): Uint8Array;
/**
* The same as deflate, but creates raw data, without wrapper (header and adler32 crc).
*/
export function deflateRaw(data: Data, options: DeflateFunctionOptions & { to: 'string' }): string;
export function deflateRaw(data: Data, options?: DeflateFunctionOptions): Uint8Array;
/**
* The same as deflate, but create gzip wrapper instead of deflate one.
*/
export function gzip(data: Data, options: DeflateFunctionOptions & { to: 'string' }): string;
export function gzip(data: Data, options?: DeflateFunctionOptions): Uint8Array;
/**
* 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: Data, options: InflateFunctionOptions & { to: 'string' }): string;
export function inflate(data: Data, options?: InflateFunctionOptions): Uint8Array;
/**
* The same as inflate, but creates raw data, without wrapper (header and adler32 crc).
*/
export function inflateRaw(data: Data, options: InflateFunctionOptions & { to: 'string' }): string;
export function inflateRaw(data: Data, options?: InflateFunctionOptions): Uint8Array;
/**
* Just shortcut to inflate, because it autodetects format by header.content. Done for convenience.
*/
export function ungzip(data: Data, options: InflateFunctionOptions & { to: 'string' }): string;
export function ungzip(data: Data, options?: InflateFunctionOptions): Uint8Array;
export class Deflate {
constructor(options?: DeflateOptions);
err: ReturnCodes;
msg: string;
result: Uint8Array | number[];
onData(chunk: Data): void;
onEnd(status: number): void;
push(data: Data | ArrayBuffer, mode?: FlushValues | boolean): boolean;
}
export class Inflate {
constructor(options?: InflateOptions);
err: ReturnCodes;
msg: string;
result: Data;
onData(chunk: Data): void;
onEnd(status: number): void;
push(data: Data | ArrayBuffer, mode?: FlushValues | boolean): boolean;
export = Pako;
export as namespace pako;
declare namespace Pako {
enum FlushValues {
Z_NO_FLUSH = 0,
Z_PARTIAL_FLUSH = 1,
Z_SYNC_FLUSH = 2,
Z_FULL_FLUSH = 3,
Z_FINISH = 4,
Z_BLOCK = 5,
Z_TREES = 6,
}
enum StrategyValues {
Z_FILTERED = 1,
Z_HUFFMAN_ONLY = 2,
Z_RLE = 3,
Z_FIXED = 4,
Z_DEFAULT_STRATEGY = 0,
}
enum ReturnCodes {
Z_OK = 0,
Z_STREAM_END = 1,
Z_NEED_DICT = 2,
Z_ERRNO = -1,
Z_STREAM_ERROR = -2,
Z_DATA_ERROR = -3,
Z_BUF_ERROR = -5,
}
interface DeflateOptions {
level?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
windowBits?: number;
memLevel?: number;
strategy?: StrategyValues;
dictionary?: any;
raw?: boolean;
to?: 'string';
chunkSize?: number;
gzip?: boolean;
header?: Header;
}
interface DeflateFunctionOptions {
level?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
windowBits?: number;
memLevel?: number;
strategy?: StrategyValues;
dictionary?: any;
raw?: boolean;
to?: 'string';
}
interface InflateOptions {
windowBits?: number;
dictionary?: any;
raw?: boolean;
to?: 'string';
chunkSize?: number;
}
interface InflateFunctionOptions {
windowBits?: number;
raw?: boolean;
to?: 'string';
}
interface Header {
text?: boolean;
time?: number;
os?: number;
extra?: number[];
name?: string;
comment?: string;
hcrc?: boolean;
}
type Data = Uint8Array | number[] | string;
/**
* Compress data with deflate algorithm and options.
*/
function deflate(data: Data, options: DeflateFunctionOptions & { to: 'string' }): string;
function deflate(data: Data, options?: DeflateFunctionOptions): Uint8Array;
/**
* The same as deflate, but creates raw data, without wrapper (header and adler32 crc).
*/
function deflateRaw(data: Data, options: DeflateFunctionOptions & { to: 'string' }): string;
function deflateRaw(data: Data, options?: DeflateFunctionOptions): Uint8Array;
/**
* The same as deflate, but create gzip wrapper instead of deflate one.
*/
function gzip(data: Data, options: DeflateFunctionOptions & { to: 'string' }): string;
function gzip(data: Data, options?: DeflateFunctionOptions): Uint8Array;
/**
* Decompress data with inflate/ungzip and options. Autodetect format via wrapper header
* by default. That's why we don't provide separate ungzip method.
*/
function inflate(data: Data, options: InflateFunctionOptions & { to: 'string' }): string;
function inflate(data: Data, options?: InflateFunctionOptions): Uint8Array;
/**
* The same as inflate, but creates raw data, without wrapper (header and adler32 crc).
*/
function inflateRaw(data: Data, options: InflateFunctionOptions & { to: 'string' }): string;
function inflateRaw(data: Data, options?: InflateFunctionOptions): Uint8Array;
/**
* Just shortcut to inflate, because it autodetects format by header.content. Done for convenience.
*/
function ungzip(data: Data, options: InflateFunctionOptions & { to: 'string' }): string;
function ungzip(data: Data, options?: InflateFunctionOptions): Uint8Array;
class Deflate {
constructor(options?: DeflateOptions);
err: ReturnCodes;
msg: string;
result: Uint8Array | number[];
onData(chunk: Data): void;
onEnd(status: number): void;
push(data: Data | ArrayBuffer, mode?: FlushValues | boolean): boolean;
}
class Inflate {
constructor(options?: InflateOptions);
err: ReturnCodes;
msg: string;
result: Data;
onData(chunk: Data): void;
onEnd(status: number): void;
push(data: Data | ArrayBuffer, mode?: FlushValues | boolean): boolean;
}
}
+1 -1
View File
@@ -1,6 +1,6 @@
{
"extends": "dtslint/dt.json",
"rules": {
"export-just-namespace": false
}
}