From 3ad8a227eb2d98b99a515696a66b7c7bb12c95af Mon Sep 17 00:00:00 2001 From: leibale Date: Tue, 9 Nov 2021 18:24:01 -0500 Subject: [PATCH] update examples --- examples/README.md | 17 +++++++++-------- examples/search+json.js | 2 +- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/examples/README.md b/examples/README.md index 9b28531521..aef0b38bdb 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,13 +2,14 @@ This folder contains example scripts showing how to use Node Redis in different scenarios. -| File Name | Description | -|-----------------------------|--------------------------------------| -| `connect-as-acl-user.js` | Connect to Redis 6 using an ACL user | -| `blocking-list-pop.js` | Block until an element is pushed to a list | -| `lua-multi-incr.js` | Define a custom lua script that allows you to perform INCRBY on multiple keys | -| `command-with-modifiers.js` | Define a script that allows to run a command with several modifiers | -| `set-scan.js` | An example script that shows how to use the SSCAN iterator functionality | +| 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](https://redisearch.io/) and [Redis JSON](https://redisjson.io/) | +| `set-scan.js` | An example script that shows how to use the SSCAN iterator functionality | ## Contributing @@ -46,7 +47,7 @@ When adding a new example, please follow these guidelines: * 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](connect-as-acl-user.js) as a guide to develop a well formatted example script. +Use [connect-as-acl-user.js](./connect-as-acl-user.js) as a guide to develop a well formatted example script. ### Example Template diff --git a/examples/search+json.js b/examples/search+json.js index 43eaa2a158..647daab623 100644 --- a/examples/search+json.js +++ b/examples/search+json.js @@ -1,4 +1,4 @@ -// RediSearch & ReJSON example +// Use Redis Search and Redis JSON import { createClient, SchemaFieldTypes, AggregateGroupByReducers, AggregateSteps } from 'redis';