Comment on page

Scripts

Apply lua scripts on redis server

Overview
Running lua scripts can be done using the runScripts method
runScripts(...scripts: Array<ScriptResource>): Promise<any>
The ScriptResource provides an API for loading inline scripts and file scripts
Inline scripts
Using the ofScript method allows us to create a script from inline text
Example:
const inlineScriptResource = ScriptResource.OfScript('return redis.call("HSET",KEYS[1],ARGV[1],ARGV[2])')
                                            .setKeys('myKey')
                                            .setArgs('FIELD', 'myValue');
await RedisProvider.GetConnection().runScripts(inlineScriptResource);
File scripts
Using the ofFile method allows us to create a script from inline text
Example:
const fileScriptResource = OfFile(__dirname + '/lua-scripts/myScript.lua')
                                            .setKeys('myKey')
                                            .setArgs('FIELD', 'myValue');
await RedisProvider.GetConnection().runScripts(fileScriptResource);

@sugoi/redis - Previous

Pub/Sub

Next - @sugoi/core

Getting started

Last modified 4yr ago