FUNCTION LIST - Upstash Documentation

Arguments

optionsbodyObject

The list options.

libraryNamebodystring

Pattern for matching library names.

withCodebodybooleandefault: false

Whether to include the library source code in the response.

Response

Object[]required

List of libraries.

libraryNamestringrequired

The name of the library.

enginestringrequired

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

functionsObject[]required

List of functions in the library.

namestringrequired

The name of the function.

descriptionstring | undefinedrequired

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

flagsstring[]required

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

libraryCodestring

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 ..."//   }// ]