类:ZstdOptions


🌐 Class: ZstdOptions

稳定性: 1 - 实验性

每个基于 Zstd 的类都接受一个 options 对象。所有选项都是可选的。

🌐 Each Zstd-based class takes an options object. All options are optional.

  • flush <integer> 默认: zlib.constants.ZSTD_e_continue
  • finishFlush <integer> 默认: zlib.constants.ZSTD_e_end
  • chunkSize <integer> 默认: 16 * 1024
  • params <Object> 包含索引 Zstd 参数 的键值对象。
  • pledgedSrcSize <number> 未压缩输入的预期总大小。它必须是非负的安全整数,并且在压缩完成时必须与输入大小匹配。仅适用于 Zstd 压缩器。
  • maxOutputLength <integer> 在使用 便捷方法 时限制输出大小。默认值: buffer.kMaxLength
  • info <boolean> 如果 true,则返回包含 buffer 和 engine 的对象。默认值: false
  • dictionary <Buffer> | <TypedArray> | <DataView> | <ArrayBuffer> 可选字典,用于在压缩或解压与字典共享常见模式的数据时提高压缩效率。
  • rejectGarbageAfterEnd <boolean> 如果 true,在完整的 Zstd 帧序列之后输入仍然存在时,解压会失败。默认值: false

例如:

🌐 For example:

const stream = zlib.createZstdCompress({
  chunkSize: 32 * 1024,
  params: {
    [zlib.constants.ZSTD_c_compressionLevel]: 10,
    [zlib.constants.ZSTD_c_checksumFlag]: 1,
  },
});