redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00
Code Activity

update examples

Browse Source
This commit is contained in:
leibale
2021-11-09 18:24:01 -05:00
parent 162ac4ce64
commit 3ad8a227eb
2 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
examples/README.md
View File

@@ -2,13 +2,14 @@
This folder contains example scripts showing how to use Node Redis in different scenarios. This folder contains example scripts showing how to use Node Redis in different scenarios.
| File Name | Description | | 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 |
| `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 |
| `lua-multi-incr.js` | Define a custom lua script that allows you to perform INCRBY on multiple keys | | `connect-as-acl-user.js` | Connect to Redis 6 using an ACL user |
| `command-with-modifiers.js` | Define a script that allows to run a command with several modifiers | | `lua-multi-incr.js` | Define a custom lua script that allows you to perform INCRBY on multiple keys |
| `set-scan.js` | An example script that shows how to use the SSCAN iterator functionality | | `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 ## 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 * Leave an empty line at the end of your `.js` file
* Update this `README.md` file to add your example to the table * 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 ### Example Template

2
examples/search+json.js
View File

@@ -1,4 +1,4 @@
// RediSearch & ReJSON example // Use Redis Search and Redis JSON
import { createClient, SchemaFieldTypes, AggregateGroupByReducers, AggregateSteps } from 'redis'; import { createClient, SchemaFieldTypes, AggregateGroupByReducers, AggregateSteps } from 'redis';