Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 4.05 KB

README.md

File metadata and controls

121 lines (83 loc) · 4.05 KB
Raw

@mongodb-js/zstd

CI

Zstandard compression library for Node.js

Installation

npm install @mongodb-js/zstd

Release Integrity

Releases are created automatically and signed using the Node team's GPG key. This applies to the git tag as well as all release packages provided as part of a GitHub release. To verify the provided packages, download the key and import it using gpg:

gpg --import node-driver.asc

The GitHub release contains a detached signature file for the NPM package (named mongodb-js-zstd-X.Y.Z.tgz.sig).

The following command returns the link npm package.

npm view @mongodb-js/zstd@vX.Y.Z dist.tarball

Using the result of the above command, a curl command can return the official npm package for the release.

To verify the integrity of the downloaded package, run the following command:

gpg --verify mongodb-js-zstd-X.Y.Z.tgz.sig mongodb-js-zstd-X.Y.Z.tgz

Note

No verification is done when using npm to install the package. The contents of the Github tarball and npm's tarball are identical.

To verify the native .node packages, follow the same steps as above using mongodb-js-zstd-X.Y.Z-platform.tgz and the corresponding .sig file.

MongoDB Node.js Driver Version Compatibility

Only the following version combinations with the MongoDB Node.js Driver are considered stable.

@mongodb-js/zstd@1.x @mongodb-js/zstd@2.x
mongodb@>=6.12 ✓ ^1.1.0 ^2.0.0
mongodb@<6.12 ✓ ^1.1.0 N/A
mongodb@5.x ✓ N/A
mongodb@4.x ✓ N/A
mongodb@3.x N/A N/A

Note

@mongodb-js/zstd@1.x is deprecated - please use @mongodb-js/zstd@2.x instead.

Prebuild Platforms

Below are the platforms that are available as prebuilds on each github release. prebuild-install downloads these automatically depending on the platform you are running npm install on.

  • Linux GLIBC 2.23 or later
    • s390x
    • arm64
    • x64
  • Linux MUSL 1.1.20
    • arm64
    • x64
  • MacOS universal binary
    • x64
    • arm64
  • Windows
    • 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);
})();

Running Tests

First, install and build the zstd library:

npm run install-zstd

Then build the bindings:

npm run prebuild

Then test: npm test