Create Redis Key - An NPM Package to Config & Create Redis Keys

Overview of My Submission

I created an NPM package named as create-redis-key

A Redis key creation utility.

Create Redis Key Templates, which include parameters, using a nested config object & use your Redis Key Template strings to create Redis Keys.

I published an introduction post for the package on DEV.to!

Explained my motivation for developing such package on the motivation section of my introduction post for the package.

The code released under MIT licence on GitHub.

Submission Category:

Wacky Wildcards

[Optional: Video Explainer of My Project]

None.

Language Used

Typescript & NodeJS

Link to Code

See create-redis-key on GitHub.

alper-guven / create-redis-key

Redis key creation utility

Create Redis Key

A Redis key creation utility.

Create Redis Key Templates, which include parameters, using a nested config object & use your Redis Key Template strings to create Redis Keys.

This package heavily uses Template Literal Types which is available since TypeScript 4.1 so you need at least this version of Typescript for this package to properly work.

Examples

See it on action (StackBlitz)

Check How to Use section to see explanations of usage options on examples.

Sections

• Installation
• How It Works
• How to Use
  • Option 1 (Recommended)
  • Option 2
  • Option 3 (Basic)
• Documentation
  • Terms
  • Functions
• FAQ
• Running Tests
• Local Development
• Contributing

Installation

Install create-redis-key with npm

  npm install create-redis-key

Type definitions? Included!

How It Works

Eventual purpose of this library is to create a Redis Key (which is basically a string) using a template which we call in this library a Redis Key Template.

There is…

View on GitHub

See create-redis-key on NPM.

create-redis-key - npm

A Redis key creation utility.. Latest version: 1.0.1, last published: 2 days ago. Start using create-redis-key in your project by running `npm i create-redis-key`. There are no other projects in the npm registry using create-redis-key.

npmjs.com

Additional Resources / Info

My package is well documented & tested. Ready for production use.

Collaborators

@alperguven

---

• Check out Redis OM, client libraries for working with Redis as a multi-model database.
• Use RedisInsight to visualize your data in Redis.
• Sign up for a free Redis database.