{"_id":"@toondepauw/node-zstd","_rev":"5-68e1a4deb4a678395120df6b8b915d84","name":"@toondepauw/node-zstd","dist-tags":{"latest":"2.0.0","next":"2.0.0-rc.1"},"versions":{"1.1.0-rc.0":{"name":"@toondepauw/node-zstd","version":"1.1.0-rc.0","license":"MIT","_id":"@toondepauw/node-zstd@1.1.0-rc.0","maintainers":[{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"}],"homepage":"https://github.com/toondepauw/node-zstd#readme","bugs":{"url":"https://github.com/toondepauw/node-zstd/issues"},"ava":{"timeout":"3m"},"dist":{"shasum":"67d0965589d00dbb5acfee1f51b9eca4b062ca58","tarball":"https://registry.npmjs.org/@toondepauw/node-zstd/-/node-zstd-1.1.0-rc.0.tgz","fileCount":11,"integrity":"sha512-d5FgKPbbkeoFAQV+OlYFhXlo7hAPKvPaT89dwa45kOaWVyXqZKl41i+3HXyEj9D3pp6PeZMfVedoo1WO6oImxw==","signatures":[{"sig":"MEUCICJ+kS4PeriDtaU/8ZRHED5KB8IW0x+Exc95MmOlhEtMAiEAxpUN+pCCpoNMa3e+Cxkb+RSdzHMnfrclbb9HPRLiS/0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@toondepauw%2fnode-zstd@1.1.0-rc.0","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"unpackedSize":19576},"main":"index.js","napi":{"name":"node-zstd","triples":{"additional":["aarch64-apple-darwin","aarch64-unknown-linux-gnu","aarch64-unknown-linux-musl","x86_64-unknown-freebsd","x86_64-unknown-linux-musl"]}},"types":"index.d.ts","engines":{"node":">= 10"},"gitHead":"b81ae52ca9ddf09e14026914cae566078ead5a80","scripts":{"test":"ava","build":"napi build --platform --release","version":"napi version","artifacts":"napi artifacts","universal":"napi universal","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm"},"_npmUser":{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"},"repository":{"url":"git+https://github.com/toondepauw/node-zstd.git","type":"git"},"_npmVersion":"9.6.7","description":"Node.js addon for native Zstandard encoding and decoding with support for dictionaries.","directories":{},"_nodeVersion":"18.17.1","dependencies":{"@toondepauw/node-zstd-darwin-x64":"1.1.0-rc.0","@toondepauw/node-zstd-freebsd-x64":"1.1.0-rc.0","@toondepauw/node-zstd-darwin-arm64":"1.1.0-rc.0","@toondepauw/node-zstd-linux-x64-gnu":"1.1.0-rc.0","@toondepauw/node-zstd-linux-x64-musl":"1.1.0-rc.0","@toondepauw/node-zstd-win32-x64-msvc":"1.1.0-rc.0","@toondepauw/node-zstd-linux-arm64-gnu":"1.1.0-rc.0","@toondepauw/node-zstd-linux-arm64-musl":"1.1.0-rc.0"},"_hasShrinkwrap":false,"packageManager":"yarn@3.6.1","devDependencies":{"ava":"^5.1.1","@types/node":"^20.4.9","@napi-rs/cli":"^2.16.2"},"optionalDependencies":{"@toondepauw/node-zstd-darwin-x64":"1.1.0-rc.0","@toondepauw/node-zstd-freebsd-x64":"1.1.0-rc.0","@toondepauw/node-zstd-darwin-arm64":"1.1.0-rc.0","@toondepauw/node-zstd-linux-x64-gnu":"1.1.0-rc.0","@toondepauw/node-zstd-linux-x64-musl":"1.1.0-rc.0","@toondepauw/node-zstd-win32-x64-msvc":"1.1.0-rc.0","@toondepauw/node-zstd-linux-arm64-gnu":"1.1.0-rc.0","@toondepauw/node-zstd-linux-arm64-musl":"1.1.0-rc.0"},"_npmOperationalInternal":{"tmp":"tmp/node-zstd_1.1.0-rc.0_1692437190866_0.5181120034395899","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@toondepauw/node-zstd","version":"1.1.0","license":"MIT","_id":"@toondepauw/node-zstd@1.1.0","maintainers":[{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"}],"homepage":"https://github.com/toondepauw/node-zstd#readme","bugs":{"url":"https://github.com/toondepauw/node-zstd/issues"},"ava":{"timeout":"3m"},"dist":{"shasum":"b55da4f073eba6e6f7e29a73a5014a8f6279c8c8","tarball":"https://registry.npmjs.org/@toondepauw/node-zstd/-/node-zstd-1.1.0.tgz","fileCount":11,"integrity":"sha512-dJrgdokGqgbuwzoRSK8rLWlnjqD8w6FDXKaVExjpEvzfEW7Hgks6AHBh20A9PQiaRQoynK8HjLTXIXJbzYBWrw==","signatures":[{"sig":"MEUCIFc/YJgLC6VoTKVzzUiwKV1//x1drtfjY2cdTXqeqbh0AiEAn60TnUPooi4rPm+3UIFfIp4kKlLnTTvDMCr7RUSEQC0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@toondepauw%2fnode-zstd@1.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"unpackedSize":19531},"main":"index.js","napi":{"name":"node-zstd","triples":{"additional":["aarch64-apple-darwin","aarch64-unknown-linux-gnu","aarch64-unknown-linux-musl","x86_64-unknown-freebsd","x86_64-unknown-linux-musl"]}},"types":"index.d.ts","engines":{"node":">= 10"},"gitHead":"1f35ea6ca384c438b8eec52dd9b6a5a6688f6d41","scripts":{"test":"ava","build":"napi build --platform --release","version":"napi version","artifacts":"napi artifacts","universal":"napi universal","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm"},"_npmUser":{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"},"repository":{"url":"git+https://github.com/toondepauw/node-zstd.git","type":"git"},"_npmVersion":"9.6.7","description":"Node.js addon for native Zstandard encoding and decoding with support for dictionaries.","directories":{},"_nodeVersion":"18.17.1","dependencies":{"@toondepauw/node-zstd-darwin-x64":"1.1.0","@toondepauw/node-zstd-freebsd-x64":"1.1.0","@toondepauw/node-zstd-darwin-arm64":"1.1.0","@toondepauw/node-zstd-linux-x64-gnu":"1.1.0","@toondepauw/node-zstd-linux-x64-musl":"1.1.0","@toondepauw/node-zstd-win32-x64-msvc":"1.1.0","@toondepauw/node-zstd-linux-arm64-gnu":"1.1.0","@toondepauw/node-zstd-linux-arm64-musl":"1.1.0"},"_hasShrinkwrap":false,"packageManager":"yarn@3.6.1","devDependencies":{"ava":"^5.1.1","@types/node":"^20.4.9","@napi-rs/cli":"^2.16.2"},"optionalDependencies":{"@toondepauw/node-zstd-darwin-x64":"1.1.0","@toondepauw/node-zstd-freebsd-x64":"1.1.0","@toondepauw/node-zstd-darwin-arm64":"1.1.0","@toondepauw/node-zstd-linux-x64-gnu":"1.1.0","@toondepauw/node-zstd-linux-x64-musl":"1.1.0","@toondepauw/node-zstd-win32-x64-msvc":"1.1.0","@toondepauw/node-zstd-linux-arm64-gnu":"1.1.0","@toondepauw/node-zstd-linux-arm64-musl":"1.1.0"},"_npmOperationalInternal":{"tmp":"tmp/node-zstd_1.1.0_1692437968863_0.139761249473092","host":"s3://npm-registry-packages"}},"1.2.0":{"name":"@toondepauw/node-zstd","version":"1.2.0","keywords":["zstandard","zstd","compression","decompression","encoding","decoding","node","nodejs","node-addon","node-api","napi-rs","rust"],"license":"MIT","_id":"@toondepauw/node-zstd@1.2.0","maintainers":[{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"}],"homepage":"https://github.com/toondepauw/node-zstd#readme","bugs":{"url":"https://github.com/toondepauw/node-zstd/issues"},"ava":{"timeout":"3m"},"dist":{"shasum":"97811740f57ecd7e6303ef1a61f6beeaca8bad01","tarball":"https://registry.npmjs.org/@toondepauw/node-zstd/-/node-zstd-1.2.0.tgz","fileCount":11,"integrity":"sha512-vVDvPUstF9gKEX+Kqp654bL+4UNus6pkmY8mlcJQpIw/Sn6sO9fl1PEwxB0d0unH5PmVfBUicf1lOXu74OLrCg==","signatures":[{"sig":"MEUCIQD5mojxfl/z7zHLsOmWztyu0NWIVqWznEC22E/paRuLoQIgDHKWY5jSkFOe6u5k+X1/uq5pBSHzw+0RqoFaISyFiVI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@toondepauw%2fnode-zstd@1.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"unpackedSize":19896},"main":"index.js","napi":{"name":"node-zstd","triples":{"additional":["aarch64-apple-darwin","aarch64-unknown-linux-gnu","aarch64-unknown-linux-musl","x86_64-unknown-freebsd","x86_64-unknown-linux-musl"]}},"types":"index.d.ts","engines":{"node":">= 14"},"gitHead":"99083218b70e450d78d0cb94a43b89ecc0fcf16f","scripts":{"test":"ava","build":"napi build --platform --release","version":"napi version","artifacts":"napi artifacts","universal":"napi universal","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm"},"_npmUser":{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"},"repository":{"url":"git+https://github.com/toondepauw/node-zstd.git","type":"git"},"_npmVersion":"9.6.7","description":"Node.js addon for native Zstandard encoding and decoding with support for dictionaries.","directories":{},"_nodeVersion":"18.17.1","dependencies":{"@toondepauw/node-zstd-darwin-x64":"1.2.0","@toondepauw/node-zstd-freebsd-x64":"1.2.0","@toondepauw/node-zstd-darwin-arm64":"1.2.0","@toondepauw/node-zstd-linux-x64-gnu":"1.2.0","@toondepauw/node-zstd-linux-x64-musl":"1.2.0","@toondepauw/node-zstd-win32-x64-msvc":"1.2.0","@toondepauw/node-zstd-linux-arm64-gnu":"1.2.0","@toondepauw/node-zstd-linux-arm64-musl":"1.2.0"},"_hasShrinkwrap":false,"packageManager":"yarn@3.6.1","devDependencies":{"ava":"^5.1.1","@types/node":"^20.4.9","@napi-rs/cli":"^2.16.2"},"optionalDependencies":{"@toondepauw/node-zstd-darwin-x64":"1.2.0","@toondepauw/node-zstd-freebsd-x64":"1.2.0","@toondepauw/node-zstd-darwin-arm64":"1.2.0","@toondepauw/node-zstd-linux-x64-gnu":"1.2.0","@toondepauw/node-zstd-linux-x64-musl":"1.2.0","@toondepauw/node-zstd-win32-x64-msvc":"1.2.0","@toondepauw/node-zstd-linux-arm64-gnu":"1.2.0","@toondepauw/node-zstd-linux-arm64-musl":"1.2.0"},"_npmOperationalInternal":{"tmp":"tmp/node-zstd_1.2.0_1692733719882_0.058198908314788245","host":"s3://npm-registry-packages"}},"2.0.0-rc.1":{"name":"@toondepauw/node-zstd","version":"2.0.0-rc.1","keywords":["zstandard","zstd","compression","decompression","encoding","decoding","node","nodejs","node-addon","node-api","napi-rs","rust"],"license":"MIT","_id":"@toondepauw/node-zstd@2.0.0-rc.1","maintainers":[{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"}],"homepage":"https://github.com/toondepauw/node-zstd#readme","bugs":{"url":"https://github.com/toondepauw/node-zstd/issues"},"ava":{"timeout":"3m"},"dist":{"shasum":"148c813888d0b98326250794b36174d996bfbf20","tarball":"https://registry.npmjs.org/@toondepauw/node-zstd/-/node-zstd-2.0.0-rc.1.tgz","fileCount":11,"integrity":"sha512-EEoGWIjGUj5A6COMyjsGepuwRSI7oV67lF2NLwgMCYewy/E1qSCRRFGqk8y24p0TnMIb9SpEzZ+IIAy+Jp/RKg==","signatures":[{"sig":"MEUCIQDiWk9CrRKWIckrvNIv0cB8zj85lKnsZ41HnYiOBgtoMwIgdOEdpl8MTLzMaa2m4xAielsqheCCFEyr6CMRrmPooSg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@toondepauw%2fnode-zstd@2.0.0-rc.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":36695},"main":"index.js","napi":{"targets":["x86_64-apple-darwin","x86_64-pc-windows-msvc","x86_64-unknown-linux-gnu","aarch64-apple-darwin","aarch64-unknown-linux-gnu","aarch64-unknown-linux-musl","x86_64-unknown-linux-musl"],"binaryName":"node-zstd"},"types":"index.d.ts","engines":{"node":">= 20"},"gitHead":"80b33715b6db1e94f585bb7ba3e83e91bff00d98","scripts":{"test":"ava","build":"napi build --platform --release","version":"napi version && git add npm/","artifacts":"napi artifacts","universal":"napi universalize","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm"},"_npmUser":{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"},"repository":{"url":"git+https://github.com/toondepauw/node-zstd.git","type":"git"},"_npmVersion":"10.9.7","description":"Node.js addon for native Zstandard encoding and decoding with support for dictionaries.","directories":{},"_nodeVersion":"22.22.2","_hasShrinkwrap":false,"packageManager":"yarn@3.6.1","readmeFilename":"README.md","devDependencies":{"ava":"^7.0.0","@types/node":"^20.4.9","@napi-rs/cli":"^3.5.0"},"optionalDependencies":{"@toondepauw/node-zstd-darwin-x64":"2.0.0-rc.1","@toondepauw/node-zstd-darwin-arm64":"2.0.0-rc.1","@toondepauw/node-zstd-linux-x64-gnu":"2.0.0-rc.1","@toondepauw/node-zstd-linux-x64-musl":"2.0.0-rc.1","@toondepauw/node-zstd-win32-x64-msvc":"2.0.0-rc.1","@toondepauw/node-zstd-linux-arm64-gnu":"2.0.0-rc.1","@toondepauw/node-zstd-linux-arm64-musl":"2.0.0-rc.1"},"_npmOperationalInternal":{"tmp":"tmp/node-zstd_2.0.0-rc.1_1777110769768_0.40077995469087413","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@toondepauw/node-zstd","version":"2.0.0","main":"index.js","types":"index.d.ts","napi":{"binaryName":"node-zstd","targets":["x86_64-apple-darwin","x86_64-pc-windows-msvc","x86_64-unknown-linux-gnu","aarch64-apple-darwin","aarch64-unknown-linux-gnu","aarch64-unknown-linux-musl","x86_64-unknown-linux-musl"]},"license":"MIT","devDependencies":{"@napi-rs/cli":"^3.5.0","@types/node":"^20.4.9","ava":"^7.0.0"},"ava":{"timeout":"3m"},"engines":{"node":">= 20"},"scripts":{"artifacts":"napi artifacts","build":"napi build --platform --release","build:debug":"napi build --platform","prepublishOnly":"napi prepublish -t npm","test":"ava","universal":"napi universalize","version":"napi version && git add npm/"},"packageManager":"yarn@3.6.1","repository":{"type":"git","url":"git+https://github.com/toondepauw/node-zstd.git"},"description":"Node.js addon for native Zstandard encoding and decoding with support for dictionaries.","keywords":["zstandard","zstd","compression","decompression","encoding","decoding","node","nodejs","node-addon","node-api","napi-rs","rust"],"optionalDependencies":{"@toondepauw/node-zstd-darwin-x64":"2.0.0","@toondepauw/node-zstd-win32-x64-msvc":"2.0.0","@toondepauw/node-zstd-linux-x64-gnu":"2.0.0","@toondepauw/node-zstd-darwin-arm64":"2.0.0","@toondepauw/node-zstd-linux-arm64-gnu":"2.0.0","@toondepauw/node-zstd-linux-arm64-musl":"2.0.0","@toondepauw/node-zstd-linux-x64-musl":"2.0.0"},"_id":"@toondepauw/node-zstd@2.0.0","gitHead":"7f7466930f0daf6f506fcd66e79e2b841cf2feb2","bugs":{"url":"https://github.com/toondepauw/node-zstd/issues"},"homepage":"https://github.com/toondepauw/node-zstd#readme","_nodeVersion":"22.22.2","_npmVersion":"10.9.7","dist":{"integrity":"sha512-wbHeWaxc9opOak+gIlP+SsI3mxpr8Qra0TrvoBA60uQbQjooPFAq+2BcsYlXMrMieF1eS4pSWZ4o4Y0s+W3Yeg==","shasum":"7d7f0ca6d4e9377236b9dc242c50f63237fe4ec5","tarball":"https://registry.npmjs.org/@toondepauw/node-zstd/-/node-zstd-2.0.0.tgz","fileCount":11,"unpackedSize":36655,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@toondepauw%2fnode-zstd@2.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQC8PpYBePcQqewN3aifWKpR/XWmzxk0z111H1ADctekXQIhAIQKbwkfE3inY3WNkTeo2mwcqZgV4P4YEaEMIRrIJIJW"}]},"_npmUser":{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"},"directories":{},"maintainers":[{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/node-zstd_2.0.0_1777116710498_0.6876332408882777"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-19T09:26:30.768Z","modified":"2026-04-25T11:31:50.941Z","1.1.0-rc.0":"2023-08-19T09:26:31.051Z","1.1.0":"2023-08-19T09:39:29.126Z","1.2.0":"2023-08-22T19:48:40.081Z","2.0.0-rc.1":"2026-04-25T09:52:49.913Z","2.0.0":"2026-04-25T11:31:50.635Z"},"bugs":{"url":"https://github.com/toondepauw/node-zstd/issues"},"license":"MIT","homepage":"https://github.com/toondepauw/node-zstd#readme","keywords":["zstandard","zstd","compression","decompression","encoding","decoding","node","nodejs","node-addon","node-api","napi-rs","rust"],"repository":{"type":"git","url":"git+https://github.com/toondepauw/node-zstd.git"},"description":"Node.js addon for native Zstandard encoding and decoding with support for dictionaries.","maintainers":[{"name":"toondepauw","email":"toon.depauw.developer@gmail.com"}],"readme":"# @toondepauw/node-zstd\n\n![CI workflow](https://github.com/toondepauw/node-zstd/actions/workflows/CI.yml/badge.svg)\n[![latest-release](https://badgen.net/github/release/toondepauw/node-zstd)](https://github.com/toondepauw/node-zstd)\n[![Zstandard](https://badgen.net/static/Zstandard/v1.5.7)](https://github.com/facebook/zstd/releases/tag/v1.5.7)\n[![license](https://badgen.net/github/license/toondepauw/node-zstd)](https://github.com/toondepauw/node-zstd/blob/main/LICENCE.md)\n\nNode.js addon for native [Zstandard](http://facebook.github.io/zstd/) encoding and decoding with support for dictionaries.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Support matrix](#support-matrix)\n- [API](#api)\n- [Running Tests](#running-tests)\n- [Releasing](#releasing)\n- [License](#license)\n\n## Installation\n\nWith npm:\n\n```\nnpm install @toondepauw/node-zstd\n```\n\nWith yarn:\n\n```\nyarn add @toondepauw/node-zstd\n```\n\n## Support matrix\n\n|                  | node20 | node22 | node24 |\n| ---------------- | ------ | ------ | ------ |\n| Linux arm64 gnu  | ✓      | ✓      | ✓      |\n| Linux arm64 musl | ✓      | ✓      | ✓      |\n| Linux x64 gnu    | ✓      | ✓      | ✓      |\n| Linux x64 musl   | ✓      | ✓      | ✓      |\n| macOS arm64      | ✓      | ✓      | ✓      |\n| macOS x64        | ✓      | ✓      | ✓      |\n| Windows x64      | ✓      | ✓      | ✓      |\n\n## API\n\n### Decoder\n\n```ts\nexport class Decoder {\n  constructor(dictionary?: Buffer | undefined | null);\n  decode(data: Buffer): Promise<Buffer>;\n  decodeSync(data: Buffer): Buffer;\n}\n```\n\n_These options can be provided as arguments to the decoder constructor._\n\n| Option     | Type     | Requirement  | Description                  |\n| ---------- | -------- | ------------ | ---------------------------- |\n| dictionary | `Buffer` | **Optional** | Contents of dictionary file. |\n\n### Encoder\n\n```ts\nexport class Encoder {\n  constructor(level: number, dictionary?: Buffer | undefined | null);\n  encode(data: Buffer): Promise<Buffer>;\n  encodeSync(data: Buffer): Buffer;\n}\n```\n\n_These options can be provided as arguments to the encoder constructor._\n\n| Option     | Type     | Requirement  | Description                                                                                                                 |\n| ---------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------- |\n| level      | `number` | **Required** | Zstd compression level. Can range between -7 (fastest) and 22 (slowest, best compression ratio). Level 3 is a good default. |\n| dictionary | `Buffer` | **Optional** | Contents of dictionary file.                                                                                                |\n\n## Usage\n\nThis package provides both an asynchronous and synchronous API. In most cases the asynchronous one is preferred as it is non-blocking. If blocking I/O is not a concern the synchronous API has a slight performance benefit.\n\n### Async\n\n```ts\nimport { Encoder, Decoder } from \"@toondepauw/node-zstd\";\n\nconst COMPRESSION_LEVEL = 3;\n\nconst encoder = new Encoder(COMPRESSION_LEVEL);\nconst decoder = new Decoder();\n\n(async () => {\n  const buff = Buffer.from(\"Hello, world!\");\n  const encoded = await encoder.encode(buff);\n  const decoded = await decoder.decode(encoded);\n})();\n```\n\n### Sync\n\n```ts\nimport { Encoder, Decoder } from \"@toondepauw/node-zstd\";\n\nconst COMPRESSION_LEVEL = 3;\n\nconst encoder = new Encoder(COMPRESSION_LEVEL);\nconst decoder = new Decoder();\n\nconst buff = Buffer.from(\"Hello, world!\");\nconst encoded = encoder.encodeSync(buff);\nconst decoded = decoder.decodeSync(encoded);\n```\n\n### Dictionary\n\nA [dictionary](http://facebook.github.io/zstd/#small-data) provides a better compression ratio and improved compression speed for small files, but requires the dictionary to be present during both encoding and decoding.\n\n```ts\nimport { readFileSync } from \"fs\";\nimport { Encoder, Decoder } from \"@toondepauw/node-zstd\";\n\nconst COMPRESSION_LEVEL = 3;\nconst dictionary = readFileSync(\"./dictionary\");\n\n// Same dictionary should be used for both encoding and decoding.\nconst encoder = new Encoder(COMPRESSION_LEVEL, dictionary);\nconst decoder = new Decoder(dictionary);\n```\n\n## Running Tests\n\n`npm test`\n\n## Releasing\n\nCI will automatically publish when it detects a new release after:\n\n```\nnpm version [major | minor | patch | ...]\ngit push --follow-tags origin main\n```\n\n## License\n\n[MIT © 2023 - current Toon De Pauw](LICENCE.md)\n","readmeFilename":"README.md"}