@hpcc-js/wasm-zstd 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -1
- package/dist/index.js +11 -1
- package/dist/index.js.map +4 -4
- package/package.json +7 -4
- package/src/zstd.ts +148 -33
- package/types/zstd.d.ts +34 -2
- package/src/wasm-library.ts +0 -59
- package/types/wasm-library.d.ts +0 -20
package/README.md
CHANGED
|
@@ -1,13 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Zstd
|
|
3
|
+
description: WebAssembly wrapper for the Zstandard compression library
|
|
4
|
+
outline: deep
|
|
5
|
+
---
|
|
6
|
+
|
|
1
7
|
# @hpcc-js/wasm-zstd
|
|
2
8
|
|
|
3
9
|
This package provides a WebAssembly wrapper around the [Zstandard](https://facebook.github.io/zstd/) library. This provides efficient compression and decompression of data.
|
|
4
10
|
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
7
|
-
|
|
13
|
+
::: code-group
|
|
14
|
+
```sh [npm]
|
|
8
15
|
npm install @hpcc-js/wasm-zstd
|
|
9
16
|
```
|
|
10
17
|
|
|
18
|
+
```sh [yarn]
|
|
19
|
+
yarn add @hpcc-js/wasm-zstd
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
```sh [pnpm]
|
|
23
|
+
pnpm add @hpcc-js/wasm-zstd
|
|
24
|
+
```
|
|
25
|
+
:::
|
|
26
|
+
|
|
11
27
|
## Usage
|
|
12
28
|
|
|
13
29
|
```typescript
|
|
@@ -22,6 +38,8 @@ const compressed_data = zstd.compress(data);
|
|
|
22
38
|
const decompressed_data = zstd.decompress(compressed_data);
|
|
23
39
|
```
|
|
24
40
|
|
|
41
|
+
<!--@include: ../../docs/zstd/src/zstd/README.md-->
|
|
42
|
+
|
|
25
43
|
## Reference
|
|
26
44
|
|
|
27
45
|
* [API Documentation](https://hpcc-systems.github.io/hpcc-js-wasm/zstd/src/zstd/classes/Zstd.html)
|