Installations

npm install keyv-lru-files

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.4.0

NPM Version

6.14.4 Score

59.8

Supply Chain

87

Quality

70.9

Maintenance

50

Vulnerability

97.3

License

Pull Requests

Open

1

Total

18

Closed

15

Merged

2

Issues

Open

2

Total

2

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

gumlet

Download Statistics

Total Downloads

6,321

Last Day

16

Last Week

38

Last Month

95

Last Year

590

GitHub Statistics

MIT License

5 Stars

61 Commits

1 Forks

1 Watchers

1 Branches

Updated on Sep 21, 2024

Bundle Size

565.78 kB

Minified

247.44 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

1.3.1

Package Id

keyv-lru-files@1.3.1

Unpacked Size

22.89 kB

Size

7.14 kB

File Count

9

NPM Version

6.14.4

Node Version

14.4.0

Total Downloads

Cumulative downloads

Total Downloads

6,321

Last Day

700%

16

Compared to previous day

Last Week

111.1%

38

Compared to previous week

Last Month

23.4%

95

Compared to previous month

Last Year

20.9%

590

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

rimraf sqlite sqlite3

Dev Dependencies

2

coveralls jest

Keyv lru files

A file cache inspired by lru-cache. Least recently used files are deleted. It's helpful if your filesystem uses atime. Everything is written to files and nothing is kept in-memory.

Install

npm install keyv-lru-files

Usgae

1
2var lrufiles = require("keyv-lru-files");
3
4var cache = new lrufiles({
5	dir: "cache" 			// directory to store caches files
6	files: 100,       // maximum number of files
7	size: "1 GB",     // maximum total file size
8	check: 10,  // interval of stale checks in minutes
9});
10
11// add a file to cache. you can submit a buffer...
12await cache.set("filename.ext", new Buffer("data"));
13
14// ... readable stream ...
15await cache.set("otherfile.ext", fs.createReadableStream("/some/filename.ext"));
16
17// ... or object
18await cache.set("objectfile.json", {hello: "world"});
19
20// get a file from cache
21// the value is a Buffer
22let value = cache.get("somefile.ext");
23
24// get a readable stream to a cached file, straight...
25let stream = await cache.stream("anyfile.ext");
26
27// check if a file is cached
28let exists = await cache.has("filename.ext");
29
30// update a files access time
31await cache.touch("file/changed.txt");
32
33// get list of all files cached
34let keys = await cache.keys();
35
36// remove a file from cache
37let deleted = await cache.delete("file/changed.txt");
38
39// manually remove old files
40await cache.cache_cleaner();
41
42// empty everything
43await cache.clear();
44
45// All functions return a promise so following syntax can be used for all functions
46// this is alternate way when you don't want to use async / await.
47cache.has("filename.ext").then(function(exists){
48	// do something...
49}).catch(function(err){
50	// there was error checking file existence
51});
52

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

Token-Permissions

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

0

Pinned-Dependencies

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

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.

Score

3.4

/10

Last Scanned on 2025-05-12

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