Installations

npm install @painsoftware/steno

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=14.16

Node Version

14.16.0

NPM Version

7.9.0 Pull Requests

Open

1

Total

20

Closed

9

Merged

10

Issues

Open

0

Total

15

Closed

15

Releases

8

v4.0.2

Published on 26 Dec 2023

v4.0.1

Published on 26 Dec 2023

v4.0.0

Published on 26 Dec 2023

v3.2.0

Published on 26 Dec 2023

v3.1.0

Published on 07 Oct 2023

v3.0.0

Published on 17 Oct 2022

View all 8 releases

Contributors

9

Unable to fetch Contributors

View all 9 contributors

Languages

2

JavaScript

Shell

JavaScript (97.52%)

Shell (2.48%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

typicode

Download Statistics

Total Downloads

266

Last Day

2

Last Week

3

Last Month

9

Last Year

83

GitHub Statistics

682 Stars

156 Commits

41 Forks

7 Watching

2 Branches

9 Contributors

Bundle Size

1.99 kB

Minified

853.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

3.0.0

Package Id

@painsoftware/steno@3.0.0

Unpacked Size

7.97 kB

Size

3.07 kB

File Count

5

NPM Version

7.9.0

Node Version

14.16.0

Publised On

16 Apr 2023

Total Downloads

Cumulative downloads

Total Downloads

266

Last day

0%

2

Compared to previous day

Last week

0%

3

Compared to previous week

Last month

50%

9

Compared to previous month

Last year

-54.6%

83

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

10

@commitlint/cli @commitlint/config-conventional @commitlint/prompt-cli @sindresorhus/tsconfig @types/node @typicode/eslint-config del-cli husky typescript xv

Versions

Steno

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

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