[io.file.list-recursively]

io.file.list-recursively is a slot in the io namespace, in Hyperlambda, the language of Magic Cloud. Lists files recursively in the specified folder.

  • Value (folder-path), required: Folder path to list files from
  • Returns: Returns one unnamed child node per relative file path, recursively

Arguments

Required arguments come first, then the optional ones in the order they are declared.

Argument Type Required Description
[display-hidden] bool no Whether hidden files or folders should be included. Default: false.
[display-system] bool no Whether system folders such as /system/, /misc/, /data/, and /config/ should be included. Default: true.

Guide: How to use [io.file.list-recursively]

JSON declaration

This is the complete declaration of io.file.list-recursively, as the running system describes it. It is also published as slot.json.

JSON declaration
{
  "name": "io.file.list-recursively",
  "description": "Lists files recursively in the specified folder",
  "signature": {
    "input": {
      "kind": "folder-path",
      "description": "Folder path to list files from",
      "required": true,
      "mode": "ValueOrExpression"
    },
    "children": {
      "display-hidden": {
        "type": "bool",
        "kind": "boolean",
        "description": "Whether hidden files or folders should be included",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "default": "false"
      },
      "display-system": {
        "type": "bool",
        "kind": "boolean",
        "description": "Whether system folders such as /system/, /misc/, /data/, and /config/ should be included",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "default": "true"
      }
    },
    "output": {
      "mode": "Lambda",
      "kind": "file-path-list,string-list",
      "element-kind": "file-path,text",
      "description": "Returns one unnamed child node per relative file path, recursively"
    }
  }
}

← io.file.list all io.* slots io.file.load →