Skip to main content

ListfilesOptions

Type

Configuration options for the filesystem.listfiles function.

Properties

Recursive

ListfilesOptions.Recursive: boolean?

If true, recursively list contents of all subdirectories. Defaults to false.

Hidden

ListfilesOptions.Hidden: boolean?

If true, include hidden files and folders in the listing. Defaults to true.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Recursive",
            "desc": "If true, recursively list contents of all subdirectories. Defaults to false.",
            "lua_type": "boolean?",
            "source": {
                "line": 15,
                "path": "impl/Types/ListfilesOptions.luau"
            }
        },
        {
            "name": "Hidden",
            "desc": "If true, include hidden files and folders in the listing. Defaults to true.",
            "lua_type": "boolean?",
            "source": {
                "line": 23,
                "path": "impl/Types/ListfilesOptions.luau"
            }
        }
    ],
    "types": [],
    "name": "ListfilesOptions",
    "desc": "Configuration options for the `filesystem.listfiles` function.",
    "tags": [
        "Type"
    ],
    "source": {
        "line": 7,
        "path": "impl/Types/ListfilesOptions.luau"
    }
}