{"id":29943033,"url":"https://github.com/mongodb-js/zstd","last_synced_at":"2025-08-03T02:13:00.640Z","repository":{"id":38188123,"uuid":"462888419","full_name":"mongodb-js/zstd","owner":"mongodb-js","description":"A Zstd Compression Library","archived":false,"fork":false,"pushed_at":"2025-07-01T22:46:12.000Z","size":868,"stargazers_count":78,"open_issues_count":6,"forks_count":12,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-08-02T01:28:34.877Z","etag":null,"topics":["compression","mongodb","node-js","nodejs","zstd"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mongodb-js.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-02-23T20:04:29.000Z","updated_at":"2025-07-10T15:09:56.000Z","dependencies_parsed_at":"2024-09-02T00:05:50.050Z","dependency_job_id":"a51f8758-f106-434f-97a1-a04dcb3cdebf","html_url":"https://github.com/mongodb-js/zstd","commit_stats":{"total_commits":60,"total_committers":11,"mean_commits":5.454545454545454,"dds":"0.19999999999999996","last_synced_commit":"e7e8df676e3a6948b67708938495eb876d5bf117"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/mongodb-js/zstd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb-js%2Fzstd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb-js%2Fzstd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb-js%2Fzstd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb-js%2Fzstd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mongodb-js","download_url":"https://codeload.github.com/mongodb-js/zstd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb-js%2Fzstd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268484362,"owners_count":24257660,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compression","mongodb","node-js","nodejs","zstd"],"created_at":"2025-08-03T02:12:51.911Z","updated_at":"2025-08-03T02:13:00.627Z","avatar_url":"https://github.com/mongodb-js.png","language":"JavaScript","readme":"# @mongodb-js/zstd\n\n[![CI](https://github.com/mongodb-js/zstd/actions/workflows/test.yml/badge.svg)](https://github.com/mongodb-js/zstd/actions/workflows/test.yml)\n\nZstandard compression library for Node.js\n\n## Installation\n\n```\nnpm install @mongodb-js/zstd\n```\n\n### Release Integrity\n\nReleases 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:\n\n```\ngpg --import node-driver.asc\n```\n\nThe GitHub release contains a detached signature file for the NPM package (named\n`mongodb-js-zstd-X.Y.Z.tgz.sig`).\n\nThe following command returns the link npm package. \n```shell\nnpm view @mongodb-js/zstd@vX.Y.Z dist.tarball \n```\n\nUsing the result of the above command, a `curl` command can return the official npm package for the release.\n\nTo verify the integrity of the downloaded package, run the following command:\n```shell\ngpg --verify mongodb-js-zstd-X.Y.Z.tgz.sig mongodb-js-zstd-X.Y.Z.tgz\n```\n\n\u003e[!Note]\nNo verification is done when using npm to install the package. The contents of the Github tarball and npm's tarball are identical.\n\nTo 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.\n\n## MongoDB Node.js Driver Version Compatibility\n\nOnly the following version combinations with the [MongoDB Node.js Driver](https://github.com/mongodb/node-mongodb-native) are considered stable.\n\n|                  | `@mongodb-js/zstd@1.x` | `@mongodb-js/zstd@2.x` |\n| ---------------- | ---------------------- | ---------------------- |\n| `mongodb@\u003e=6.12` | ✓ `^1.1.0`             | `^2.0.0`               |\n| `mongodb@\u003c6.12`  | ✓ `^1.1.0`             | N/A                    |\n| `mongodb@5.x`    | ✓                      | N/A                    |\n| `mongodb@4.x`    | ✓                      | N/A                    |\n| `mongodb@3.x`    | N/A                    | N/A                    |\n\n\u003e[!Note]\n\u003e `@mongodb-js/zstd@1.x` is deprecated - please use `@mongodb-js/zstd@2.x` instead.\n\n#### Prebuild Platforms\n\nBelow are the platforms that are available as prebuilds on each github release.\n`prebuild-install` downloads these automatically depending on the platform you are running npm install on.\n\n- Linux GLIBC 2.23 or later\n    - s390x\n    - arm64\n    - x64\n- Linux MUSL 1.1.20\n    - arm64\n    - x64\n- MacOS universal binary\n    - x64\n    - arm64\n- Windows\n    - x64\n\n## API\n\n```ts\nexport function compress(buffer: Buffer | ArrayBuffer | Uint8Array, level: number): Promise\u003cBuffer\u003e;\nexport function decompress(buffer: Buffer): Promise\u003cBuffer\u003e;\n```\n\n### Bugs / Feature Requests\n\nThink you’ve found a bug? Want to see a new feature in `@mongodb-js/zstd`? Please open a\ncase in our issue management tool, JIRA:\n\n- Create an account and login [jira.mongodb.org](https://jira.mongodb.org).\n- Navigate to the NODE project [jira.mongodb.org/browse/NODE](https://jira.mongodb.org/browse/NODE).\n- Click **Create Issue** - Please provide as much information as possible about the issue type and how to reproduce it.\n\n### Support / Feedback\n\nFor 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).\n\n### Change Log\n\nChange history can be found in [`HISTORY.md`](https://github.com/mongodb-js/zstd/blob/HEAD/HISTORY.md).\n\n## Usage\n\n```ts\nimport { compress, decompress } from '@mongodb-js/zstd';\n\n(async () =\u003e {\n  const buffer = Buffer.from('test');\n  const compressed = await compress(buffer, 10);\n  const decompressed = await decompress(compressed);\n})();\n```\n\n## Running Tests\n\nFirst, install and build the zstd library:\n\n`npm run install-zstd`\n\nThen build the bindings:\n\n`npm run prebuild`\n\nThen test:\n`npm test`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb-js%2Fzstd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmongodb-js%2Fzstd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb-js%2Fzstd/lists"}