Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added TypeScript typings #5

Merged
merged 4 commits into from Oct 31, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
51 changes: 51 additions & 0 deletions index.d.ts
@@ -0,0 +1,51 @@
declare module 'zlib-sync' {
export interface InflateOptions {
chunkSize?: number;
to?: string;
windowBits?: number;
}

export class Inflate {
readonly windowBits: number;
readonly result: Buffer;
TheAkio marked this conversation as resolved.
Show resolved Hide resolved
readonly msg: string;
readonly err: number;
readonly chunkSize: number;
public constructor(options?: InflateOptions);
public push(buffer: Buffer, flush?: boolean | number): void;
}

export const Z_NO_FLUSH: number;
export const Z_PARTIAL_FLUSH: number;
export const Z_SYNC_FLUSH: number;
export const Z_FULL_FLUSH: number;
export const Z_FINISH: number;
export const Z_BLOCK: number;
export const Z_TREES: number;
export const Z_OK: number;
export const Z_STREAM_END: number;
export const Z_NEED_DICT: number;
export const Z_ERRNO: number;
export const Z_STREAM_ERROR: number;
export const Z_DATA_ERROR: number;
export const Z_MEM_ERROR: number;
export const Z_BUF_ERROR: number;
export const Z_VERSION_ERROR: number;
export const Z_NO_COMPRESSION: number;
export const Z_BEST_SPEED: number;
export const Z_BEST_COMPRESSION: number;
export const Z_DEFAULT_COMPRESSION: number;
export const Z_FILTERED: number;
export const Z_HUFFMAN_ONLY: number;
export const Z_RLE: number;
export const Z_FIXED: number;
export const Z_DEFAULT_STRATEGY: number;
export const Z_BINARY: number;
export const Z_TEXT: number;
export const Z_ASCII: number;
export const Z_UNKNOWN: number;
export const Z_DEFLATED: number;
export const Z_NULL: number;

export const ZLIB_VERSION: string;
}
4 changes: 3 additions & 1 deletion package.json
Expand Up @@ -2,7 +2,8 @@
"name": "zlib-sync",
"version": "0.1.5",
"description": "Synchronous zlib bindings for NodeJS",
"main": "index.js",
"main": "index.js",
TheAkio marked this conversation as resolved.
Show resolved Hide resolved
"types": "index.d.ts",
"scripts": {
"lint": "eslint --fix test",
"test": "mocha"
Expand All @@ -25,6 +26,7 @@
"nan": "^2.14.0"
},
"devDependencies": {
"@types/node": "^12.11.7",
"mocha": "^4.0.1"
}
}