Installations
npm install snappyDeveloper
Brooooooklyn
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>= 10
Typescript Support
Yes
Node Version
16.18.0
NPM Version
8.19.2
Statistics
165 Stars
251 Commits
10 Forks
4 Watching
2 Branches
4 Contributors
Updated on 25 Nov 2024
Languages
Rust (50.01%)
TypeScript (34.86%)
JavaScript (14.57%)
Shell (0.56%)
Total Downloads
Cumulative downloads
Total Downloads
113,186,846
Last day
-20.2%
60,543
Compared to previous day
Last week
-6.6%
347,487
Compared to previous week
Last month
11.6%
1,502,498
Compared to previous month
Last year
-26.1%
17,954,283
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
13
@napi-rs/snappy-win32-x64-msvc@napi-rs/snappy-darwin-x64@napi-rs/snappy-linux-x64-gnu@napi-rs/snappy-linux-x64-musl@napi-rs/snappy-linux-arm64-gnu@napi-rs/snappy-win32-ia32-msvc@napi-rs/snappy-linux-arm-gnueabihf@napi-rs/snappy-darwin-arm64@napi-rs/snappy-android-arm64@napi-rs/snappy-android-arm-eabi@napi-rs/snappy-freebsd-x64@napi-rs/snappy-linux-arm64-musl@napi-rs/snappy-win32-arm64-msvc
Dev Dependencies
22
Optional Dependencies
13
@napi-rs/snappy-win32-x64-msvc@napi-rs/snappy-darwin-x64@napi-rs/snappy-linux-x64-gnu@napi-rs/snappy-linux-x64-musl@napi-rs/snappy-linux-arm64-gnu@napi-rs/snappy-win32-ia32-msvc@napi-rs/snappy-linux-arm-gnueabihf@napi-rs/snappy-darwin-arm64@napi-rs/snappy-android-arm64@napi-rs/snappy-android-arm-eabi@napi-rs/snappy-freebsd-x64@napi-rs/snappy-linux-arm64-musl@napi-rs/snappy-win32-arm64-msvc
Versions
snappy
!!! For snappy@6.x and below, please go to node-snappy.
More background about the 6-7 changes, please read this, Thanks @kesla .
🚀 Help me to become a full-time open-source developer by sponsoring me on Github
Fastest Snappy compression library in Node.js, powered by napi-rs and rust-snappy.
For small size data, snappyjs is faster, and it support browser. But it doesn't have async API, which is important for Node.js program.
Install this package
yarn add snappy
Support matrix
| node12 | node14 | node16 | node18 | |
|---|---|---|---|---|
| Windows x64 | ✓ | ✓ | ✓ | ✓ |
| Windows x32 | ✓ | ✓ | ✓ | ✓ |
| Windows arm64 | ✓ | ✓ | ✓ | ✓ |
| macOS x64 | ✓ | ✓ | ✓ | ✓ |
| macOS arm64 | ✓ | ✓ | ✓ | ✓ |
| Linux x64 gnu | ✓ | ✓ | ✓ | ✓ |
| Linux x64 musl | ✓ | ✓ | ✓ | ✓ |
| Linux arm gnu | ✓ | ✓ | ✓ | ✓ |
| Linux arm64 gnu | ✓ | ✓ | ✓ | ✓ |
| Linux arm64 musl | ✓ | ✓ | ✓ | ✓ |
| Android arm64 | ✓ | ✓ | ✓ | ✓ |
| Android armv7 | ✓ | ✓ | ✓ | ✓ |
| FreeBSD x64 | ✓ | ✓ | ✓ | ✓ |
API
1export function compressSync(input: Buffer | string | ArrayBuffer | Uint8Array): Buffer 2export function compress(input: Buffer | string | ArrayBuffer | Uint8Array): Promise<Buffer> 3export function uncompressSync(compressed: Buffer): Buffer 4export function uncompress(compressed: Buffer): Promise<Buffer>
Performance
Hardware
OS: Windows 11 x86_64
Host: Micro-Star International Co., Ltd. MS-7C35
Kernel: 10.0.22000
Terminal: Windows Terminal
CPU: AMD Ryzen 9 5950X (32) @ 3.400GHz
Memory: 32688MiB
Result
Running "Compress" suite...
Progress: 100%
snappy:
4 220 ops/s, ±0.66% | fastest
snappy-v6:
2 018 ops/s, ±0.84% | 52.18% slower
gzip:
233 ops/s, ±0.52% | slowest, 94.48% slower
deflate:
235 ops/s, ±0.45% | 94.43% slower
brotli:
7 ops/s, ±0.51% | slowest, 99.85% slower
Finished 4 cases!
Fastest: snappy
Slowest: brotli
Running "Decompress" suite...
Progress: 100%
snappy:
8 528 ops/s, ±1.03% | fastest
snappy-v6:
6 357 ops/s, ±1.76% | 25.46% slower
gzip:
1 406 ops/s, ±1.80% | slowest, 83.51% slower
deflate:
1 435 ops/s, ±1.88% | 83.17% slower
brotli:
1 208 ops/s, ±1.50% | slowest, 86.99% slower
Finished 4 cases!
Fastest: snappy
Slowest: brotli
No vulnerabilities found.
Reason
17 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Reason
Found 0/16 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/CI.yaml:7
- Warn: no topLevel permission defined: .github/workflows/lint.yaml:1
- Warn: no topLevel permission defined: .github/workflows/memory-leak-detect.yaml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:94: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:126: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:201: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:203: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:211: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:294: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:296: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:309: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:314: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:406: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:408: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:415: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:135: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:138: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:174: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:232: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:234: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:241: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:262: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:264: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:273: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:328: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:330: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:343: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:348: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:367: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yaml:369: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:381: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yaml:386: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/CI.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/lint.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/lint.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yaml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/lint.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/memory-leak-detect.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/memory-leak-detect.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/memory-leak-detect.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/memory-leak-detect.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/memory-leak-detect.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Brooooooklyn/snappy/memory-leak-detect.yaml/main?enable=pin
- Info: 0 out of 29 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 12 third-party GitHubAction dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v7.2.2 not signed: https://api.github.com/repos/Brooooooklyn/snappy/releases/82911185
- Warn: release artifact v7.2.1 not signed: https://api.github.com/repos/Brooooooklyn/snappy/releases/80728436
- Warn: release artifact v7.2.0 not signed: https://api.github.com/repos/Brooooooklyn/snappy/releases/79037683
- Warn: release artifact v7.1.2 not signed: https://api.github.com/repos/Brooooooklyn/snappy/releases/73994103
- Warn: release artifact v7.1.1 not signed: https://api.github.com/repos/Brooooooklyn/snappy/releases/55822356
- Warn: release artifact v7.2.2 does not have provenance: https://api.github.com/repos/Brooooooklyn/snappy/releases/82911185
- Warn: release artifact v7.2.1 does not have provenance: https://api.github.com/repos/Brooooooklyn/snappy/releases/80728436
- Warn: release artifact v7.2.0 does not have provenance: https://api.github.com/repos/Brooooooklyn/snappy/releases/79037683
- Warn: release artifact v7.1.2 does not have provenance: https://api.github.com/repos/Brooooooklyn/snappy/releases/73994103
- Warn: release artifact v7.1.1 does not have provenance: https://api.github.com/repos/Brooooooklyn/snappy/releases/55822356
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
4.3
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More