Skip to main content

Arguments

function
string
required
The function name.
keys
string[]
The keys that the function accesses.
The function can only read/write from the keys that are provided in the keys argument.
args
string[]
The arguments for the function.

Response

The return value of the function.
const code = `
#!lua name=mylib
redis.register_function('helloworld', 
  function()
    return 'Hello World!'
  end
)
`;

await redis.functions.load({ code, replace: true });

const res = await redis.functions.call("helloworld");
console.log(res); // "Hello World!"
const code = `
#!lua name=mylib

redis.register_function('my_hset',
  function (keys, args)
    local hash = keys[1]
    local time = redis.call('TIME')[1]
    return redis.call('HSET', hash, '_last_modified_', time, unpack(args))
  end
)
`;

await redis.functions.load({ code, replace: true });

const res = await redis.functions.call(
  "my_hset",
  ["myhash"],
  [
    "myfield",
    "some value",
    "another_field",
    "another value",
  ],
);