zstd-wasm-vn 1.1.0 → 1.2.1

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.
@@ -1,5 +1,88 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
+
4
+ /**
5
+ * ZSTD compression and decompression for WebAssembly
6
+ */
7
+ export class Zstd {
8
+ private constructor();
9
+ free(): void;
10
+ [Symbol.dispose](): void;
11
+ static compress(data: Uint8Array, level?: number | null): Uint8Array;
12
+ /**
13
+ * Estimates the compressed size for planning purposes
14
+ */
15
+ static compressBound(input_size: number): number;
16
+ static compress_with_dict(data: Uint8Array, dict: Uint8Array, level?: number | null): Uint8Array;
17
+ /**
18
+ * Calculates compression ratio (smaller = better compression)
19
+ */
20
+ static compressionRatio(original_size: number, compressed_size: number): number;
21
+ static decompress(compressed_data: Uint8Array): Uint8Array;
22
+ static decompress_with_dict(compressed_data: Uint8Array, dict: Uint8Array): Uint8Array;
23
+ /**
24
+ * Returns the recommended default compression level
25
+ */
26
+ static defaultCompressionLevel(): number;
27
+ /**
28
+ * Returns the maximum compression level
29
+ */
30
+ static maxCompressionLevel(): number;
31
+ /**
32
+ * Returns the minimum compression level
33
+ */
34
+ static minCompressionLevel(): number;
35
+ /**
36
+ * Calculates space savings percentage
37
+ */
38
+ static spaceSavings(original_size: number, compressed_size: number): number;
39
+ }
40
+
41
+ /**
42
+ * ==================================== [Streaming] ====================================
43
+ * Streaming compression for large data
44
+ */
45
+ export class ZstdCompressor {
46
+ free(): void;
47
+ [Symbol.dispose](): void;
48
+ /**
49
+ * Compresses a chunk of data
50
+ */
51
+ compress_chunk(data: Uint8Array): void;
52
+ /**
53
+ * Finalizes compression and returns the compressed data
54
+ */
55
+ finalize(): Uint8Array;
56
+ /**
57
+ * Creates a new streaming compressor
58
+ */
59
+ constructor(level?: number | null);
60
+ /**
61
+ * Flush the internal buffer to get compressed data for this chunk
62
+ */
63
+ split_off_chunk(at: number): Uint8Array;
64
+ }
65
+
66
+ /**
67
+ * Streaming decompression for large data
68
+ */
69
+ export class ZstdDecompressor {
70
+ free(): void;
71
+ [Symbol.dispose](): void;
72
+ /**
73
+ * Decompresses a chunk of data
74
+ */
75
+ decompress_chunk(max_output_size: number): Uint8Array;
76
+ /**
77
+ * Decompresses all remaining data and consumes the decoder.
78
+ */
79
+ finalize(): Uint8Array;
80
+ /**
81
+ * Creates a new streaming decompressor
82
+ */
83
+ constructor(compressed_data: Uint8Array);
84
+ }
85
+
3
86
  /**
4
87
  * Compresses data using Zstandard compression
5
88
  *
@@ -9,6 +92,18 @@
9
92
  * * `level` - Compression level (1-22, default 6). Higher = better compression but slower
10
93
  */
11
94
  export function compress(data: Uint8Array, level?: number | null): Uint8Array;
95
+
96
+ /**
97
+ * Compresses data using Zstandard compression with a dictionary
98
+ *
99
+ * # Arguments
100
+ *
101
+ * * `data` - Input data to compress
102
+ * * `dict` - The compression dictionary
103
+ * * `level` - Compression level (1-22, default 6). Higher = better compression but slower
104
+ */
105
+ export function compress_with_dict(data: Uint8Array, dict: Uint8Array, level?: number | null): Uint8Array;
106
+
12
107
  /**
13
108
  * Decompresses Zstandard compressed data
14
109
  *
@@ -17,75 +112,13 @@ export function compress(data: Uint8Array, level?: number | null): Uint8Array;
17
112
  * * `compressed_data` - Zstandard compressed data
18
113
  */
19
114
  export function decompress(compressed_data: Uint8Array): Uint8Array;
115
+
20
116
  /**
21
- * ZSTD compression and decompression for WebAssembly
22
- */
23
- export class Zstd {
24
- private constructor();
25
- free(): void;
26
- [Symbol.dispose](): void;
27
- static compress(data: Uint8Array, level?: number | null): Uint8Array;
28
- static decompress(compressed_data: Uint8Array): Uint8Array;
29
- /**
30
- * Returns the recommended default compression level
31
- */
32
- static defaultCompressionLevel(): number;
33
- /**
34
- * Returns the minimum compression level
35
- */
36
- static minCompressionLevel(): number;
37
- /**
38
- * Returns the maximum compression level
39
- */
40
- static maxCompressionLevel(): number;
41
- /**
42
- * Estimates the compressed size for planning purposes
43
- */
44
- static compressBound(input_size: number): number;
45
- /**
46
- * Calculates compression ratio (smaller = better compression)
47
- */
48
- static compressionRatio(original_size: number, compressed_size: number): number;
49
- /**
50
- * Calculates space savings percentage
51
- */
52
- static spaceSavings(original_size: number, compressed_size: number): number;
53
- }
54
- /**
55
- * Streaming compression for large data
56
- */
57
- export class ZstdCompressor {
58
- free(): void;
59
- [Symbol.dispose](): void;
60
- /**
61
- * Creates a new streaming compressor
62
- */
63
- constructor(level?: number | null);
64
- /**
65
- * Compresses a chunk of data
66
- */
67
- compress_chunk(data: Uint8Array): void;
68
- /**
69
- * Finalizes compression and returns the compressed data
70
- */
71
- finalize(): Uint8Array;
72
- }
73
- /**
74
- * Streaming decompression for large data
117
+ * Decompresses Zstandard compressed data using a dictionary
118
+ *
119
+ * # Arguments
120
+ *
121
+ * * `data` - Zstandard compressed data
122
+ * * `dict` - The decompression dictionary (must match the compression dictionary)
75
123
  */
76
- export class ZstdDecompressor {
77
- free(): void;
78
- [Symbol.dispose](): void;
79
- /**
80
- * Creates a new streaming decompressor
81
- */
82
- constructor(compressed_data: Uint8Array);
83
- /**
84
- * Decompresses a chunk of data
85
- */
86
- decompress_chunk(max_output_size: number): Uint8Array;
87
- /**
88
- * Decompresses all remaining data and consumes the decoder.
89
- */
90
- finalize(): Uint8Array;
91
- }
124
+ export function decompress_with_dict(data: Uint8Array, dict: Uint8Array): Uint8Array;
@@ -1,5 +1,9 @@
1
+ /* @ts-self-types="./zstd_wasm_vn.d.ts" */
2
+
1
3
  import * as wasm from "./zstd_wasm_vn_bg.wasm";
2
- export * from "./zstd_wasm_vn_bg.js";
3
4
  import { __wbg_set_wasm } from "./zstd_wasm_vn_bg.js";
4
5
  __wbg_set_wasm(wasm);
5
6
  wasm.__wbindgen_start();
7
+ export {
8
+ Zstd, ZstdCompressor, ZstdDecompressor, compress, compress_with_dict, decompress, decompress_with_dict
9
+ } from "./zstd_wasm_vn_bg.js";