npmpackage.info

Gathering detailed insights and metrics for keyv-file

Other packages similar to keyv-file

@keyvhq/file

2.1.7

A file storage adapter for Keyv

keyv-fs

1.0.2

file system storage adapter for keyv

keyv-lru-files

1.3.1

Nodejs key-value LRU cache which uses filesystem as storage

key-value-file

1.0.10

A simple key/value file parser/writer

Gathering detailed insights and metrics for keyv-file

keyv-file - 5.1.2 | npmpackage.info

keyv-file

File storage adapter for Keyv, using json to serialize data.

5.1.2

MIT

TypeScript

12.98 kB

1,963,585 2.1

Installations

npm install keyv-file

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.16.0

NPM Version

10.8.1 Score

97.5

Supply Chain

87.3

Quality

82.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

17

Closed

9

Merged

8

Issues

Open

2

Total

10

Closed

8

Releases

Unable to fetch releases

Languages

TypeScript

JavaScript

TypeScript (88.05%)

JavaScript (11.95%)

Developer

zaaack

Download Statistics

Total Downloads

1,963,585

Last Day

6,922

Last Week

30,965

Last Month

127,083

Last Year

1,251,754

GitHub Statistics

MIT License

76 Stars

72 Commits

11 Forks

3 Watchers

1 Branches

8 Contributors

Updated on May 11, 2025

Bundle Size

43.60 kB

Minified

12.98 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 8 Contributors

Package Meta Information

Latest Version

5.1.2

Package Id

keyv-file@5.1.2

Unpacked Size

13.16 kB

Size

4.44 kB

File Count

NPM Version

10.8.1

Node Version

20.16.0

Published on

Mar 02, 2025

Total Downloads

Cumulative downloads

Total Downloads

1,963,585

Dependencies

@keyv/serialize fs-extra tslib

Dev Dependencies

@keyv/test-suite @types/debug @types/fs-extra @types/node benchmark keyv typescript vitest

keyv-file

File storage adapter for Keyv, using json to serialize data fast and small.

File storage adapter for Keyv.

TTL functionality is handled internally by interval scan, don't need to panic about expired data take too much space.

Install

1npm install --save keyv keyv-file

Usage

Using with keyv

1const Keyv = require('keyv')
2const { KeyvFile } = require('keyv-file')
3
4const keyv = new Keyv({
5  store: new KeyvFile()
6});
7// More options with default value:
8const customKeyv = new Keyv({
9  store: new KeyvFile({
10    filename: `${os.tmpdir()}/keyv-file/default-rnd-${Math.random().toString(36).slice(2)}.json`, // the file path to store the data
11    expiredCheckDelay: 24 * 3600 * 1000, // ms, check and remove expired data in each ms
12    writeDelay: 100, // ms, batch write to disk in a specific duration, enhance write performance.
13    encode: JSON.stringify, // serialize function
14    decode: JSON.parse // deserialize function
15  })
16})

Using directly

1import KeyvFile, { makeField } from 'keyv-file'
2
3class Kv extends KeyvFile {
4  constructor() {
5    super({
6      filename: './db.json'
7    })
8  }
9  someField = makeField(this, 'field_key')
10}
11
12export const kv = new Kv
13
14kv.someField.get(1) // empty return default value 1
15kv.someField.set(2) // set value 2
16kv.someField.get() // return saved value 2
17kv.someField.delete() // delete field

License

MIT

No vulnerabilities found.

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.

2

Maintained

Determines if the project is "actively maintained".

1

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.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.1

/10

Last Scanned on 2025-05-05

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

Other packages similar to keyv-file

Other packages similar to keyv-file

keyv-file

Installations

Developer Guide

Yes

CommonJS

20.16.0

10.8.1

Score

Pull Requests

0

17

9

8

Issues

2

10

8

Releases

Unable to fetch releases

Languages

Developer

zaaack

Download Statistics

GitHub Statistics

Bundle Size

43.60 kB

12.98 kB

Maintainers

Package Meta Information

Total Downloads

1,963,585

Dependencies

Dev Dependencies

keyv-file

Install

Usage

Using with keyv

Using directly

License

10

10

2

1

0

0

0

0

0

0

2.1

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads