peasy-compress 0.2.0 → 0.2.2
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 +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/peasy-compress)
|
|
4
4
|
[](https://www.typescriptlang.org/)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
[](https://github.com/peasytools/peasy-compress-js)
|
|
6
7
|
|
|
7
8
|
Archive and compression library for Node.js -- ZIP create/extract/list/add, gzip, brotli, and deflate. TypeScript-first with full type safety, built on Node.js native `zlib` and `adm-zip`.
|
|
8
9
|
|
|
@@ -11,7 +12,7 @@ Built from [Peasy Compress](https://peasytools.com), the developer tools platfor
|
|
|
11
12
|
> **Try the interactive tools at [peasytools.com](https://peasytools.com)** -- compression, archiving, and 255 more browser-based tools
|
|
12
13
|
|
|
13
14
|
<p align="center">
|
|
14
|
-
<img src="
|
|
15
|
+
<a href="https://agentgif.com/Pwc8MQwG"><img src="https://media.agentgif.com/Pwc8MQwG.gif" alt="peasy-compress demo — file compression and decompression in terminal" width="800"></a>
|
|
15
16
|
</p>
|
|
16
17
|
|
|
17
18
|
## Table of Contents
|
|
@@ -105,7 +106,7 @@ const files = zipExtract(updated);
|
|
|
105
106
|
Object.keys(files); // ["src/index.ts", "package.json", "LICENSE", "README.md"]
|
|
106
107
|
```
|
|
107
108
|
|
|
108
|
-
Learn more: [
|
|
109
|
+
Learn more: [Archive Formats Compared](https://peasytools.com/guides/archive-formats-compared/) · [What is Lossless Compression?](https://peasytools.com/glossary/lossless-compression/) · [What is Compression Ratio?](https://peasytools.com/glossary/compression-ratio/)
|
|
109
110
|
|
|
110
111
|
### Gzip Compression
|
|
111
112
|
|
|
@@ -131,7 +132,7 @@ const fast = gzipCompress(html, 1);
|
|
|
131
132
|
const best = gzipCompress(html, 9);
|
|
132
133
|
```
|
|
133
134
|
|
|
134
|
-
Learn more: [
|
|
135
|
+
Learn more: [Lossless vs Lossy Compression Guide](https://peasytools.com/guides/lossless-vs-lossy-compression-guide/) · [What is Archive?](https://peasytools.com/glossary/archive/) · [What is Entropy?](https://peasytools.com/glossary/entropy/)
|
|
135
136
|
|
|
136
137
|
### Brotli Compression
|
|
137
138
|
|
|
@@ -155,7 +156,7 @@ console.log(original.equals(css)); // true
|
|
|
155
156
|
const quick = brotliCompress(css, 1);
|
|
156
157
|
```
|
|
157
158
|
|
|
158
|
-
Learn more: [
|
|
159
|
+
Learn more: [Archive Compression Formats Explained](https://peasytools.com/guides/archive-compression-formats-explained/) · [What is Brotli?](https://peasytools.com/glossary/brotli/) · [What is Lossy Compression?](https://peasytools.com/glossary/lossy-compression/)
|
|
159
160
|
|
|
160
161
|
### Deflate Compression
|
|
161
162
|
|
|
@@ -175,7 +176,7 @@ const fast = deflateCompress(data, 1);
|
|
|
175
176
|
const best = deflateCompress(data, 9);
|
|
176
177
|
```
|
|
177
178
|
|
|
178
|
-
Learn more: [
|
|
179
|
+
Learn more: [Archive Format ZIP TAR 7z RAR Compared](https://peasytools.com/guides/archive-format-zip-tar-7z-rar-compared/) · [What is TAR?](https://peasytools.com/glossary/tar/) · [What is Lossless Compression?](https://peasytools.com/glossary/lossless-compression/)
|
|
179
180
|
|
|
180
181
|
## TypeScript Types
|
|
181
182
|
|
|
@@ -257,10 +258,9 @@ Full API documentation at [peasytools.com/developers/](https://peasytools.com/de
|
|
|
257
258
|
|
|
258
259
|
## Learn More
|
|
259
260
|
|
|
260
|
-
- **
|
|
261
|
-
- **
|
|
262
|
-
- **
|
|
263
|
-
- **Formats**: [ZIP](https://peasytools.com/formats/zip/) · [Gzip](https://peasytools.com/formats/gzip/) · [All Formats](https://peasytools.com/formats/)
|
|
261
|
+
- **Guides**: [Archive Formats Compared](https://peasytools.com/guides/archive-formats-compared/) · [Lossless vs Lossy Compression](https://peasytools.com/guides/lossless-vs-lossy-compression-guide/) · [Archive Compression Formats Explained](https://peasytools.com/guides/archive-compression-formats-explained/) · [Archive Format ZIP TAR 7z RAR Compared](https://peasytools.com/guides/archive-format-zip-tar-7z-rar-compared/) · [PDF Compression Guide](https://peasytools.com/guides/pdf-compression-guide/) · [All Guides](https://peasytools.com/guides/)
|
|
262
|
+
- **Glossary**: [Archive](https://peasytools.com/glossary/archive/) · [TAR](https://peasytools.com/glossary/tar/) · [Brotli](https://peasytools.com/glossary/brotli/) · [Lossless Compression](https://peasytools.com/glossary/lossless-compression/) · [Lossy Compression](https://peasytools.com/glossary/lossy-compression/) · [Compression Ratio](https://peasytools.com/glossary/compression-ratio/) · [Entropy](https://peasytools.com/glossary/entropy/) · [All Terms](https://peasytools.com/glossary/)
|
|
263
|
+
- **Formats**: [ZIP](https://peasytools.com/formats/zip/) · [TAR](https://peasytools.com/formats/tar/) · [Gzip](https://peasytools.com/formats/gz/) · [7z](https://peasytools.com/formats/7z/) · [BZ2](https://peasytools.com/formats/bz2/) · [XZ](https://peasytools.com/formats/xz/) · [LZ4](https://peasytools.com/formats/lz4/) · [Zstandard](https://peasytools.com/formats/zst/) · [RAR](https://peasytools.com/formats/rar/) · [All Formats](https://peasytools.com/formats/)
|
|
264
264
|
- **API**: [REST API Docs](https://peasytools.com/developers/) · [OpenAPI Spec](https://peasytools.com/api/openapi.json)
|
|
265
265
|
|
|
266
266
|
## Also Available
|
package/package.json
CHANGED