IFileSystemQueryOptions

Represents the options passable to FileSystemOverlay.read_directory

Index

glob: undefined | string

Represents a Bash Shell Glob pattern to match paths with

NOTE: When using "Globstar", "**", the backend will search recursively for sub-paths, which may incur a performance penalty

is_directory: undefined | false | true

Represents to only query for File System Entries that are Directories

is_file: undefined | false | true

Represents to only query for File System Entries that are Files

path: undefined | string

Represents a Directory path to read File System Entries from

recursive: undefined | false | true

Represents if the IFileSystemQueryOptions.path option should recursively search in child Directories too

NOTE: When set to true, the backend will search recursively for children, which may incur a performance penalty

regex: RegExp

Represents a Regular Expression to match paths with

NOTE: When using the "Global Match" flag, "g", the backend will search recursively for children, which may incur a performance penalty

Generated using TypeDoc