File.readDir
$dir.readDir($options={}) -> list
Description
Read a directory, and return the contents as a List of file TypeStrings.
By default, it will only include files, not subdirectories.
dir'files:/someDir'.readDir() // Ex: [ // 《 FileTypeString 'data/files/someDir/file1.txt' 》 // 《 FileTypeString 'data/files/someDir/file2.txt' 》 // ]
Options
| Option | Value | Description |
|---|---|---|
filter |
files, dirs, all |
Type of contents to include |
deep |
true/false | Include contents of subdirectories |
dir'files:/someDir'.readDir({ filter: 'dirs' })
// Ex: [
// 《 FileTypeString 'data/files/someDir/subdir1' 》
// 《 FileTypeString 'data/files/someDir/subdir2' 》
// ]
dir'files:/someDir'.readDir({ filter: 'all' })
// Ex: [
// 《 FileTypeString 'data/files/someDir/file1.txt' 》
// 《 FileTypeString 'data/files/someDir/file2.txt' 》
// 《 DirTypeString 'data/files/someDir/subdir1' 》
// 《 DirTypeString 'data/files/someDir/subdir2' 》
// ]
dir'files:/someDir'.readDir({ deep })
// Ex: [
// 《 FileTypeString 'data/files/someDir/file1.txt' 》
// 《 FileTypeString 'data/files/someDir/file2.txt' 》
// 《 FileTypeString 'data/files/someDir/subdir1/file3.txt' 》
// ]