# @mongodb-js/zstd > [![CI](https://github.com/mongodb-js/zstd/actions/workflows/test.yml/badge.svg)](https://github.com/mongodb-js/zstd/actions/workflows/test.yml) Latest version **7.0.0** (published 2025-11-05) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @mongodb-js/zstd pnpm add @mongodb-js/zstd yarn add @mongodb-js/zstd bun add @mongodb-js/zstd ``` ## Health **Score 65/100 (B)** — status: stable. Positive: has types; no vulnerabilities; has provenance; high maintenance score; high quality score. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 7.0.0 | | Published | 2025-11-05 | | First published | 2022-05-06 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >= 20.19.0 | | Dependencies | 2 | | Unpacked size | 27.2 KB | | Known vulnerabilities | 0 | | Install scripts | yes | | Provenance | attested (GitHub Actions) | | GitHub stars | 81 | | Maintainers | mongodb-js-user, rueckstiess, durran, alexander_schroll, mbroadst, hswolff, satyasinha, matt_d_rat, jeff-allen-mongo, jonathan.balsano, mongodb-build, jack.weir, mcasimir, kristina.stefano, jarjee, shaketbaby, devtoolsbot, addaleax, gribnoysup, mutukrish, mongo-j, nbbeeken, dbx-node, nirinchev, pearsb1 | ## Links - npm: https://www.npmjs.com/package/@mongodb-js/zstd - Repository: https://github.com/mongodb-js/zstd - Homepage: https://github.com/mongodb-js/zstd#readme - Issues: https://github.com/mongodb-js/zstd/issues - npm.io page: https://npm.io/package/@mongodb-js/zstd ## Dependencies (2) - [node-addon-api](https://npm.io/package/node-addon-api.md) ^8.5.0 - [prebuild-install](https://npm.io/package/prebuild-install.md) ^7.1.3 ## Recent versions - 7.0.0 (latest) — 2025-11-05 - 3.0.0-alpha (alpha) — 2025-10-21 - 2.0.1 — 2025-03-19 - 2.0.0 — 2024-12-06 - 2.0.0-alpha.3 — 2024-12-05 - 2.0.0-alpha.2 — 2024-12-04 - 2.0.0-alpha.1 — 2024-12-02 - 2.0.0-alpha.0 — 2024-11-27 - 1.2.2 — 2024-09-16 - 1.2.1 — 2024-09-06 - 1.2.0 — 2023-08-29 - 1.1.0 — 2023-01-23 - 1.0.0 — 2022-05-18 - 0.0.7 — 2022-05-18 - 0.0.6 — 2022-05-18 - … 4 more at https://npm.io/package/@mongodb-js/zstd/versions ## README # @mongodb-js/zstd [![CI](https://github.com/mongodb-js/zstd/actions/workflows/test.yml/badge.svg)](https://github.com/mongodb-js/zstd/actions/workflows/test.yml) 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](https://pgp.mongodb.com/node-driver.asc). 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. ```shell 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: ```shell 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](https://github.com/mongodb/node-mongodb-native) are considered stable. | | `@mongodb-js/zstd@1.x` | `@mongodb-js/zstd@2.x` | `@mongodb-js/zstd@7.x` | | ---------------- | ---------------------- | ---------------------- | ---------------------- | | `mongodb@7.x` | N/A | N/A | ✓ | | `mongodb@>=6.12` | `^1.1.0` | ✓ | N/A | | `mongodb@<6.12` | `^1.1.0` | N/A | N/A | | `mongodb@5.x` | ✓ | N/A | N/A | | `mongodb@4.x` | ✓ | N/A | N/A | | `mongodb@3.x` | N/A | 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.28 or later - s390x - arm64 - x64 - Linux MUSL 1.1.20 - arm64 - x64 - MacOS universal binary - x64 - arm64 - Windows - x64 ## API ```ts export function compress(buffer: Buffer | ArrayBuffer | Uint8Array, level: number): Promise; export function decompress(buffer: Buffer): Promise; ``` ### 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](https://jira.mongodb.org). - Navigate to the NODE project [jira.mongodb.org/browse/NODE](https://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](https://docs.mongodb.com/manual/support). 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](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/node-js-driver). ### Change Log Change history can be found in [`HISTORY.md`](https://github.com/mongodb-js/zstd/blob/HEAD/HISTORY.md). ## Usage ```ts 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` --- _Source: https://npm.io/package/@mongodb-js/zstd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._