npmpackage.info

Gathering detailed insights and metrics for @keyv/valkey

@keyv/valkey

Simple key-value storage with support for multiple backends

1.0.1

2,637

MIT

TypeScript

3,030 5.6

Installations

npm install @keyv/valkey

Pull Requests

Open

0

Total

963

Closed

49

Merged

914

Issues

Open

0

Total

250

Closed

250

Releases

2024-11-22

Published on 22 Nov 2024

2024-11-16

Published on 16 Nov 2024

2024-11-13

Published on 13 Nov 2024

2024-11-11

Published on 12 Nov 2024

2024-11-09

Published on 09 Nov 2024

2024-11-02

Published on 02 Nov 2024

View all 67 releases

Developer

jaredwray

Developer Guide

BETA

Module System

ESM

Min. Node Version

>= 18

Typescript Support

Yes

Node Version

20.17.0

NPM Version

10.9.0 Statistics

2,637 Stars

1,390 Commits

146 Forks

19 Watching

2 Branches

65 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (99.05%)

CSS (0.39%)

Shell (0.39%)

JavaScript (0.17%)

Total Downloads

Cumulative downloads

Total Downloads

3,030

Last day

-93.5%

Compared to previous day

Last week

-39.3%

551

Compared to previous week

Last month

841.2%

2,739

Compared to previous month

Last year

3,030

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

iovalkey

Dev Dependencies

@keyv/test-suite keyv rimraf timekeeper tsd xo

Versions

Simple key-value storage with support for multiple backends

How to Use the Keyv Mono Repo

Keyv and its storage adapters are in this mono repo and there are details below on how to use this repository. In addtion we have a couple of other documents for review:

CODE_OF_CONDUCT - Our code of conduct
CONTRIBUTING - How to contribute to this project
SECURITY - Security guidelines and supported versions

Getting Started

Keyv is a simple key-value storage system that supports multiple backends. It's designed to be a simple and consistent way to work with key-value stores.

To learn how to use Keyv, check out the keyv README. To learn how to use a specific storage adapter, check out the README for that adapter under Storage Adapters.

Open a Pull Request

You can contribute changes to this repo by opening a pull request:

After forking this repository to your Git account, make the proposed changes on your forked branch.
Run tests and linting locally.
- Install and run Docker if you aren't already. NOTE: on docker set enable host networking to true as it is required for the tests in redis clustering.
- Run pnpm test:services:start, allow for the services to come up.
- Run pnpm test.
Commit your changes and push them to your forked repository.
Navigate to the main keyv repository and select the Pull Requests tab.
Click the New pull request button, then select the option "Compare across forks"
Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the keyv repository.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the Github documentation

Post an Issue

To post an issue, navigate to the "Issues" tab in the main repository, and then select "New Issue." Enter a clear title describing the issue, as well as a description containing additional relevant information. Also select the label that best describes your issue type. For a bug report, for example, create an issue with the label "bug." In the description field, Be sure to include replication steps, as well as any relevant error messages.

If you're reporting a security violation, be sure to check out the project's security policy.

Please also refer to our Code of Conduct for more information on how to report issues.

Ask a Question

To ask a question, create an issue with the label "question." In the issue description, include the related code and any context that can help us answer your question.

Request the Addition of a Storage Adapter

To request a new storage adapter, create an issue with the label "storage adapter." In the issue description, include any relevant information about the storage adapter that you would like to be added.

Once this request has been submitted in "issues" we will give it 30-60 days for any upvotes to take place. If there is little interest in the request, it will be closed.

If there is already an adapter that you would like to add, please post an issue with the label "storage adapter" and include the name of the adapter you would like to add with the description and any relevant information.

Packages in this Repository

keyv: Simple key-value storage with support for multiple backends
test-suite: Test suite for Keyv API compliance

Storage Adapters

etcd: Etcd storage adapter
memcache: Memcache storage adapter
mongo: MongoDB storage adapter
mysql: MySQL/MariaDB storage adapter
postgres: PostgreSQL storage adapter
redis: Redis storage adapter
valkey: Valkey (Open Source Redis) storage adapter
sqlite: SQLite storage adapter
tiered: Tiered storage adapter to manage local and remote storage as one

Compression Adapters

brotli: Brotli compression adapter
Gzip: Gzip compression adapter

Third-party Storage Adapters

Here are the storage adapters that are not in this repository but compatible with Keyv.

quick-lru - Simple "Least Recently Used" (LRU) cache
keyv-file - File system storage adapter for Keyv
keyv-dynamodb - DynamoDB storage adapter for Keyv
keyv-lru - LRU storage adapter for Keyv
keyv-null - Null storage adapter for Keyv
keyv-firestore – Firebase Cloud Firestore adapter for Keyv
keyv-mssql - Microsoft Sql Server adapter for Keyv
keyv-azuretable - Azure Table Storage/API adapter for Keyv
keyv-arango - ArangoDB storage adapter for Keyv
keyv-momento - Momento storage adapter for Keyv
@resolid/keyv-sqlite - A new SQLite storage adapter for Keyv

License

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

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

10

Security-Policy

Determines if the project has published a security policy.

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.

10

SAST

Determines if the project uses static code analysis.

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

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codecov.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codecov.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codecov.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codecov.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/codecov.yaml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codecov.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-website.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/deploy-website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-website.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/deploy-website.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-website.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/deploy-website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/tests.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/jaredwray/keyv/tests.yaml/main?enable=pin
Warn: containerImage not pinned by hash: packages/postgres/Dockerfile.ssl:1: pin your Docker image by updating postgres:latest to postgres:latest@sha256:994cc3113ce004ae73df11f0dbc5088cbe6bb0da1691dd7e6f55474202a4f211
Warn: npmCommand not pinned by hash: .github/workflows/codecov.yaml:25
Warn: npmCommand not pinned by hash: .github/workflows/deploy-website.yml:30
Warn: npmCommand not pinned by hash: .github/workflows/tests.yaml:25
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned

0

Branch-Protection

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

Score

5.6

/10

Last Scanned on 2024-11-25

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