Skip to content

Clarify that io.readdir handles are iterated with lines() #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcellotmartins wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify that io.readdir handles are iterated with lines() #594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/docs/developers/sandbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ local files3 = io.readdir("/absolute/path/to/resource")
local files4 = io.readdir("/absolute/path/to/resource/assets")
```

Because `io.readdir()` returns a handle rather than a plain table, it cannot be iterated with `ipairs` or `pairs`. Use its `lines()` iterator to read each entry:

```lua
local files = io.readdir("@myResource/")
for file in files:lines() do
Expand Down