Skip to content

Commit

Permalink
Fix typescript definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
platypii committed Apr 26, 2024
1 parent bcab9b3 commit ca32077
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const output = snappyUncompress(compressed, outputLength)

Hysnappy was built specifically to accelerate the the [hyparquet](https://github.com/hyparam/hyparquet) parquet parsing library.

The library exports a loader function `snappyUncompressor()` which loads the WASM module once, and returns a pre-loaded version of `snappyUncompress` function.
Hysnappy exports a loader function `snappyUncompressor()` which loads the WASM module once, and returns a pre-loaded version of `snappyUncompress` function.

To use hysnappy with hyparquet:

Expand Down
2 changes: 1 addition & 1 deletion hysnappy.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* @param {Uint8Array} input
* @param {Uint8Array} output
*/
export async function snappyUncompress(input: Uint8Array, outputLength: number): Uint8Array
export function snappyUncompress(input: Uint8Array, outputLength: number): Uint8Array

/**
* Load wasm and return uncompressor function.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
"devDependencies": {
"@babel/eslint-parser": "7.24.1",
"@types/node": "20.12.7",
"@vitest/coverage-v8": "1.5.0",
"@vitest/coverage-v8": "1.5.2",
"eslint": "8.57.0",
"eslint-plugin-import": "2.29.1",
"eslint-plugin-jsdoc": "48.2.3",
"snappyjs": "0.7.0",
"vitest": "1.5.0"
"vitest": "1.5.2"
}
}
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"module": "nodenext",
"noEmit": true,
"resolveJsonModule": true,
"skipLibCheck": true,
"skipLibCheck": false,
"strict": true,
"target": "esnext"
},
Expand Down

0 comments on commit ca32077

Please sign in to comment.