Package Exports

@mongodb-js/zstd
@mongodb-js/zstd/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mongodb-js/zstd) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@mongodb-js/zstd

Zstandard compression library for Node.js

Installation

npm install @mongodb-js/zstd

Support matrix

	node12	node14	node16	node17
Windows x64	✓	✓	✓	✓
Windows arm64	✓	✓	✓	✓
macOS x64	✓	✓	✓	✓
macOS arm64	✓	✓	✓	✓
Linux x64 gnu	✓	✓	✓	✓
Linux arm gnu	✓	✓	✓	✓
Linux arm64 gnu	✓	✓	✓	✓
FreeBSD x64	✓	✓	✓	✓

API

export function compress(buffer: Buffer | ArrayBuffer | Uint8Array, level: number): Promise<Buffer>
export function decompress(buffer: Buffer): Promise<Buffer>

Bugs / Feature Requests

Think you’ve found a bug? Want to see a new feature in @mongodb-js/zstd? Please open a case in our issue management tool, JIRA:

Create an account and login jira.mongodb.org.
Navigate to the NODE project jira.mongodb.org/browse/NODE.
Click Create Issue - Please provide as much information as possible about the issue type and how to reproduce it.

Support / Feedback

For issues with, questions about, or feedback for the library, please look into our support channels. Please do not email any of the driver developers directly with issues or questions - you're more likely to get an answer on the MongoDB Community Forums.

Change Log

Change history can be found in HISTORY.md.

Usage

import { compress, decompress } from '@mongodb-js/zstd';

(async () => {
  const buffer = Buffer.from('test');
  const compressed = await compress(buffer, 10);
  const decompressed = await decompress(compressed);
})();