FUNCTION LIST

List details about the registered libraries and functions.

Arguments

options · Object

The list options.

Show child attributes

libraryName · string

Pattern for matching library names.

withCode · boolean · default: "false"

Whether to include the library source code in the response.

Response

List of libraries.

Show child attributes

libraryName · string · required

The name of the library.

engine · string · required

The engine used by the library (e.g., “LUA”).

functions · Object[] · required

List of functions in the library.

Show child attributes

name · string · required

The name of the function.

description · string | undefined · required

The description of the function, or undefined if not provided.

flags · string[] · required

List of flags for the function (e.g., “no-writes”).

libraryCode · string

The source code of the library (only included if withCode is true).

Example

const libs = await redis.functions.list({
    libraryName: "mylib",
    withCode: true
})

console.log(libs)
// [
//   {
//     libraryName: "mylib",
//     engine: "LUA",
//     functions: [{
//       name: "my_func",
//       description: null,
//       flags: [ "no-writes" ]
//     }],
//     libraryCode: "#!lua name=mylib ..."
//   }
// ]