@mongodb-js/zstd
Advanced tools
[](https://github.com/mongodb-js/zstd/actions/workflows/test.yml)
Zstandard compression library for Node.js
npm install @mongodb-js/zstd
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.
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 |
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.
export function compress(buffer: Buffer | ArrayBuffer | Uint8Array, level: number): Promise<Buffer>;
export function decompress(buffer: Buffer): Promise<Buffer>;
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:
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 history can be found in HISTORY.md.
import { compress, decompress } from '@mongodb-js/zstd';
(async () => {
const buffer = Buffer.from('test');
const compressed = await compress(buffer, 10);
const decompressed = await decompress(compressed);
})();
First, install and build the zstd library:
npm run install-zstd
Then build the bindings:
npm run prebuild
Then test:
npm test
FAQs
[](https://github.com/mongodb-js/zstd/actions/workflows/test.yml)
The npm package @mongodb-js/zstd receives a total of 146,705 weekly downloads. As such, @mongodb-js/zstd popularity was classified as popular.
We found that @mongodb-js/zstd demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 35 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.