Installations
npm install xcraft-steno
Developer Guide
Typescript
Yes
Module System
ESM
Min. Node Version
^14.13.1 || >=16.0.0
Node Version
14.20.0
NPM Version
8.14.0
Score
68.1
Supply Chain
80.2
Quality
75.3
Maintenance
100
Vulnerability
100
License
Releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (97.52%)
Shell (2.48%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
typicode
Download Statistics
Total Downloads
4,192
Last Day
11
Last Week
11
Last Month
160
Last Year
1,857
GitHub Statistics
682 Stars
156 Commits
41 Forks
7 Watching
2 Branches
9 Contributors
Sponsor this package
Package Meta Information
Latest Version
2.1.1
Package Id
xcraft-steno@2.1.1
Unpacked Size
8.61 kB
Size
3.26 kB
File Count
5
NPM Version
8.14.0
Node Version
14.20.0
Total Downloads
Cumulative downloads
Total Downloads
4,192
Last day
0%
11
Compared to previous day
Last week
-76.1%
11
Compared to previous week
Last month
9.6%
160
Compared to previous month
Last year
21.3%
1,857
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Steno
![Node.js CI](https://github.com/typicode/steno/actions/workflows/node.js.yml/badge.svg)
Specialized fast async file writer
Steno makes writing to the same file often/concurrently fast and safe.
Used in lowdb.
https://en.wikipedia.org/wiki/Stenotype
Features
- ⚡ Fast (see benchmark)
- 🐦 Lightweight (~6kb)
- 👍 ⚛️ Safe: No partial writes (writes are atomic)
- 👍 🏁 Safe: No race conditions (writes are ordered even if they're async)
Usage
1import { Writer } from 'steno' 2 3// Create a singleton writer 4const file = new Writer('file.txt') 5 6// Use it in the rest of your code 7async function save() { 8 await file.write('some data') 9}
Benchmark
npm run benchmark
(see src/benchmark.ts
)
Write 1KB data to the same file x 1000
fs : 62ms
steno : 1ms
Write 1MB data to the same file x 1000
fs : 2300ms
steno : 5ms
Steno uses a smart queue and avoids unnecessary writes.
License
MIT - Typicode
![Empty State](/_next/static/media/empty.e5fae2e5.png)
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/typicode/steno/node.js.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/typicode/steno/node.js.yml/main?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/node.js.yml:1
- Info: no jobLevel write permissions found
Reason
Found 1/29 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
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
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Score
3.3
/10
Last Scanned on 2025-01-27
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