node-redis/examples

Node Redis: Examples

This folder contains example scripts showing how to use Node Redis in different scenarios.

File Name	Description
blocking-list-pop.js	Block until an element is pushed to a list
command-with-modifiers.js	Define a script that allows to run a command with several modifiers
connect-as-acl-user.js	Connect to Redis 6 using an ACL user
lua-multi-incr.js	Define a custom lua script that allows you to perform INCRBY on multiple keys
search+json.js	Use Redis Search and Redis JSON
set-scan.js	An example script that shows how to use the SSCAN iterator functionality

Contributing

We'd love to see more examples here. If you have an idea that you'd like to see included here, submit a Pull Request and we'll be sure to review it! Don't forget to check out our contributing guide.

Setup

To set up the examples folder so that you can run an example / develop one of your own:

$ git clone https://github.com/redis/node-redis.git
$ cd node-redis
$ npm install -ws && npm run build
$ cd examples
$ npm install

Coding Guidelines for Examples

When adding a new example, please follow these guidelines:

• Add your code in a single JavaScript or TypeScript file per example, directly in the examples folder
• Do not introduce other dependencies in your example
• Give your .js file a meaningful name using - separators e.g. adding-to-a-stream.js / adding-to-a-stream.ts
• Indent your code using 2 spaces
• Use the single line // comment style and comment your code
• Add a comment at the top of your .js / .ts file describing what your example does
• Add a comment at the top of your .js / .ts file describing any Redis commands that need to be run to set up data for your example (try and keep this minimal)
• Use semicolons
• Use async and await
• Use single quotes, 'hello' not "hello"
• Place your example code in a single async function where possible, named according to the file name e.g. add-to-stream.js would contain const addtoStream = async () => { ... };, and call this function at the end of the file e.g. addToStream();
• Unless your example requires a connection string, assume Redis is on the default localhost port 6379 with no password
• Use meaningful example data, let's not use foo, bar, baz etc!
• Leave an empty line at the end of your .js file
• Update this README.md file to add your example to the table

Use connect-as-acl-user.js as a guide to develop a well formatted example script.

Example Template

Here's a starter template for adding a new example, imagine this is stored in do-something.js:

// This comment should describe what the example does
// and can extend to multiple lines.

// Set up the data in redis-cli using these commands:
//   <add your command(s) here, one per line>

import { createClient } from 'redis';

async function doSomething() {
    const client = createClient();

    await client.connect();

    // Add your example code here...

    await client.quit();
}

doSomething();