Blame view

天文台pc/tianwentai-ui/node_modules/minizlib/README.md 2.01 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
  # minizlib
  
  A fast zlib stream built on [minipass](http://npm.im/minipass) and
  Node.js's zlib binding.
  
  This module was created to serve the needs of
  [node-tar](http://npm.im/tar) and
  [minipass-fetch](http://npm.im/minipass-fetch).
  
  Brotli is supported in versions of node with a Brotli binding.
  
  ## How does this differ from the streams in `'node:zlib'`?
  
  First, there are no convenience methods to compress or decompress a
  buffer.  If you want those, use the built-in `zlib` module.  This is
  only streams.  That being said, Minipass streams to make it fairly easy to
  use as one-liners: `new zlib.Deflate().end(data).read()` will return the
  deflate compressed result.
  
  This module compresses and decompresses the data as fast as you feed
  it in.  It is synchronous, and runs on the main process thread.  Zlib
  and Brotli operations can be high CPU, but they're very fast, and doing it
  this way means much less bookkeeping and artificial deferral.
  
  Node's built in zlib streams are built on top of `stream.Transform`.
  They do the maximally safe thing with respect to consistent
  asynchrony, buffering, and backpressure.
  
  See [Minipass](http://npm.im/minipass) for more on the differences between
  Node.js core streams and Minipass streams, and the convenience methods
  provided by that class.
  
  ## Classes
  
  - Deflate
  - Inflate
  - Gzip
  - Gunzip
  - DeflateRaw
  - InflateRaw
  - Unzip
  - BrotliCompress (Node v10 and higher)
  - BrotliDecompress (Node v10 and higher)
  - ZstdCompress (Node v22.15 and higher)
  - ZstdDecompress (Node v22.15 and higher)
  
  ## USAGE
  
  ```js
  import { BrotliDecompress } from 'minizlib'
  // or: const BrotliDecompress = require('minizlib')
  
  const input = sourceOfCompressedData()
  const decode = new BrotliDecompress()
  const output = whereToWriteTheDecodedData()
  input.pipe(decode).pipe(output)
  ```
  
  ## REPRODUCIBLE BUILDS
  
  To create reproducible gzip compressed files across different operating
  systems, set `portable: true` in the options.  This causes minizlib to set
  the `OS` indicator in byte 9 of the extended gzip header to `0xFF` for
  'unknown'.