npmpackage.info

Gathering detailed insights and metrics for @alexsasharegan/simple-cache

@alexsasharegan/simple-cache - 3.3.3 | npmpackage.info

@alexsasharegan/simple-cache

A basic key value store with bounded capacity for simple caching.

3.3.3

MIT

TypeScript

52.77 kB

1.7

Installations

npm install @alexsasharegan/simple-cache

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

10.15.2

NPM Version

6.4.1 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

TypeScript

JavaScript

TypeScript (98.95%)

JavaScript (1.05%)

Developer

alexsasharegan

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1 Stars

36 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Feb 28, 2022

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

3.3.3

Package Id

@alexsasharegan/simple-cache@3.3.3

Unpacked Size

52.77 kB

Size

10.18 kB

File Count

NPM Version

6.4.1

Node Version

10.15.2

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

safe-types

Dev Dependencies

@types/jest @types/node coveralls jest standard-version ts-jest ts-node typedoc typescript

simple-cache

A basic key value store with bounded capacity for simple caching.

Install

1npm install @alexsasharegan/simple-cache

Documentation

Visit the API Documentation here.

Cache is an interface for caching key/value pairs of types K/V. It's primary functionality includes:

Cache.write: write a value at a key
Cache.read: read a value from a key
Cache.get: read a value as an Option<V> (maybe type)
Cache.remove: remove a value by key
Cache.clear: empty the cache

Usage

Creating a cache looks like this in plain JavaScript:

1// Creates a cache with a capacity of 10 items. The second parameter is the
2// "type label". It serves as a convenience option for more meaningful
3// `toString` behavior.
4let userCache = SimpleCache(10, { key: "ID", value: "User" })
5userCache.toString()
6// SimpleCache<ID, User> { size: 0, capacity: 10 }

If you're using TypeScript, you need to create a cache by declaring the key and value types as generic parameters:

1interface User {
2	id: number
3	name: string
4}
5
6let userCache = SimpleCache<number, User>(10, { key: "ID", value: "User" })
7userCache.toString()
8// SimpleCache<ID, User> { size: 0, capacity: 10 }

Here are some examples of the five main interaction methods shown in REPL style. If you're curious to learn more about the Option type returned from Cache.get, visit the safe-types repository.

1let userA = { name: "User A", id: 1 }
2let userB = { name: "User B", id: 2 }
3
4userCache.write(userA.id, userA)
5userCache.write(userB.id, userB)
6userCache.size()
7// 2
8
9userCache.read(1)
10// { name: "User A", id: 1 }
11userCache.read(2)
12// { name: "User B", id: 2 }
13userCache.get(2)
14// Some<{ name: "User B", id: 2 }>
15userCache.read(3)
16// undefined
17userCache.get(3)
18// None
19
20userCache.remove(1)
21userCache.size()
22// 1
23userCache.read(1)
24// undefined
25userCache.clear()
26userCache.size()
27// 0

There is an Ephemeral Cache available. It caches items for a duration that's given in milliseconds.

1// Sets a capacity of 10 users and a max lifetime of 5 seconds
2let userCache = EphemeralCache<number, User>(10, 5000, {
3	key: "ID",
4	value: "User",
5})
6
7userCache.write(1, { name: "Temp", id: 1 })
8
9setTimeout(() => {
10	userCache.read(1)
11	// undefined
12}, 5001)
13
14userCache.read(1)
15// { name: "Temp", id: 1 }

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.

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

71 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-xf5p-87ch-gxw2
Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-07-07

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