DirectoryInfo (Fake)

6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See

DirectoryInfo Module

Namespace: Fake.IO
Assembly: Fake.IO.FileSystem.dll

Contains tasks to interact with DirectoryInfo

Functions and values

Function or value	Description
`DirectoryInfo.containsFile fileInfo dir` Full Usage: `DirectoryInfo.containsFile fileInfo dir` Parameters: fileInfo : `FileInfo` - The file to check for dir : `DirectoryInfo` - The directory to search in Returns: `bool`	Checks if the file is in a subfolder of the dir. fileInfo : `FileInfo` The file to check for dir : `DirectoryInfo` The directory to search in Returns: `bool`
`DirectoryInfo.copyRecursiveTo overwrite outputDir dir` Full Usage: `DirectoryInfo.copyRecursiveTo overwrite outputDir dir` Parameters: overwrite : `bool` - Flag to overwrite same files in target dir outputDir : `DirectoryInfo` - The target directory to copy to dir : `DirectoryInfo` - The source directory to copy from Returns: `string list`	Copies the file structure recursively. overwrite : `bool` Flag to overwrite same files in target dir outputDir : `DirectoryInfo` The target directory to copy to dir : `DirectoryInfo` The source directory to copy from Returns: `string list`
`DirectoryInfo.copyRecursiveToWithFilter overwrite filter outputDir dir` Full Usage: `DirectoryInfo.copyRecursiveToWithFilter overwrite filter outputDir dir` Parameters: overwrite : `bool` - Flag to overwrite same files in target dir filter : `DirectoryInfo -> FileInfo -> bool` - The filter to use to filter the list of files outputDir : `DirectoryInfo` - The target directory to copy to dir : `DirectoryInfo` - The source directory to copy from Returns: `string list`	Copies the file structure recursively, filtering files. overwrite : `bool` Flag to overwrite same files in target dir filter : `DirectoryInfo -> FileInfo -> bool` The filter to use to filter the list of files outputDir : `DirectoryInfo` The target directory to copy to dir : `DirectoryInfo` The source directory to copy from Returns: `string list`
`DirectoryInfo.ensure dir` Full Usage: `DirectoryInfo.ensure dir` Parameters: dir : `DirectoryInfo` - The directory to check Modifiers: inline	Ensure that directory chain exists. Create necessary directories if necessary. dir : `DirectoryInfo` The directory to check
`DirectoryInfo.exists dir` Full Usage: `DirectoryInfo.exists dir` Parameters: dir : `DirectoryInfo` - The directory to check for Returns: `bool`	Checks if the directory exists on disk. dir : `DirectoryInfo` The directory to check for Returns: `bool`
`DirectoryInfo.getFiles dir` Full Usage: `DirectoryInfo.getFiles dir` Parameters: dir : `DirectoryInfo` - The directory to use Returns: `FileInfo[]` Modifiers: inline	Gets all files in the directory. dir : `DirectoryInfo` The directory to use Returns: `FileInfo[]`
`DirectoryInfo.getMatchingFiles pattern dir` Full Usage: `DirectoryInfo.getMatchingFiles pattern dir` Parameters: pattern : `string` - The glob pattern to use for search dir : `DirectoryInfo` - The directory to use Returns: `FileInfo[]`	Finds all the files in the directory matching the search pattern. pattern : `string` The glob pattern to use for search dir : `DirectoryInfo` The directory to use Returns: `FileInfo[]`
`DirectoryInfo.getMatchingFilesRecursive pattern dir` Full Usage: `DirectoryInfo.getMatchingFilesRecursive pattern dir` Parameters: pattern : `string` - The glob pattern to use for search dir : `DirectoryInfo` - The directory to use Returns: `FileInfo[]`	Finds all the files in the directory and in all subdirectories matching the search pattern. pattern : `string` The glob pattern to use for search dir : `DirectoryInfo` The directory to use Returns: `FileInfo[]`
`DirectoryInfo.getSubDirectories dir` Full Usage: `DirectoryInfo.getSubDirectories dir` Parameters: dir : `DirectoryInfo` - The directory to use Returns: `DirectoryInfo[]` Modifiers: inline	Gets all subdirectories of a given directory. dir : `DirectoryInfo` The directory to use Returns: `DirectoryInfo[]`
`DirectoryInfo.isSubfolderOf dir2 dir1` Full Usage: `DirectoryInfo.isSubfolderOf dir2 dir1` Parameters: dir2 : `DirectoryInfo` - The second directory to check for dir1 : `DirectoryInfo` - The first directory to check for Returns: `bool`	Checks if dir1 is a subfolder of dir2. If dir1 equals dir2 the function returns also true. dir2 : `DirectoryInfo` The second directory to check for dir1 : `DirectoryInfo` The first directory to check for Returns: `bool`
`DirectoryInfo.ofPath path` Full Usage: `DirectoryInfo.ofPath path` Parameters: path : `string` - The path to use Returns: `DirectoryInfo` Modifiers: inline	Creates a DirectoryInfo for the given path. path : `string` The path to use Returns: `DirectoryInfo`
`DirectoryInfo.setReadOnly readOnly dir` Full Usage: `DirectoryInfo.setReadOnly readOnly dir` Parameters: readOnly : `bool` - Flag to set directory to readonly or not. dir : `DirectoryInfo` - The directory to set	Sets the directory readonly readOnly : `bool` Flag to set directory to readonly or not. dir : `DirectoryInfo` The directory to set
`DirectoryInfo.setReadOnlyRecursive readOnly dir` Full Usage: `DirectoryInfo.setReadOnlyRecursive readOnly dir` Parameters: readOnly : `bool` - Flag to set directory to readonly or not. dir : `DirectoryInfo` - The directory to set	Sets all files in the directory readonly recursively. readOnly : `bool` Flag to set directory to readonly or not. dir : `DirectoryInfo` The directory to set