Class FileSystem

constructor

• new FileSystem(): FileSystem

• Returns FileSystem

StatickAltDirectorySeparatorChar

StatickDirectorySeparatorChar

StatickPosixDirectorySeparatorChar

StatickWindowsDirectorySeparatorChar

Static ReadonlypackageFileExtension

StaticchangeExtension

• changeExtension(path, extension): FilePath

• Changes the extension of a path string.

  Parameters

  • path: FilePath

    The path information to modify. The path cannot contain any of the characters defined in System.IO.Path.GetInvalidPathChars.
  • extension: string

    The new extension (with or without a leading period). Specify null to remove an existing extension from path.

  Returns FilePath

  The modified path information.On Windows-based desktop platforms, if path is null or an empty string (""), the path information is returned unmodified.

StaticcombinePaths

• combinePaths<T>(path1, path2): T

• Combines two strings into a path.

  Type Parameters

  • T extends string = FilePath

  Parameters

  • path1: string | IdentifierPath | FilePath

    The first path to combine.
  • path2: string | IdentifierPath | FilePath

    The second path to combine.

  Returns T

  The combined paths.

StaticcomparePaths

• comparePaths(a, b): boolean

• Checks if two paths are equal.

  Parameters

  • a: string | FilePath

    First path.
  • b: string | FilePath

    Second path.

  Returns boolean

  True if both paths point to the same place.

StaticcopyDirectoryRecursive

• copyDirectoryRecursive(source, destination): void

• Recursively copies a directory from one path to another, while creating any parent directories if they don't already exist.

  Parameters

  • source: FilePath

    Path to the directory to copy.
  • destination: FilePath

    Path determining where the directory copy will be placed.

  Returns void

StaticcopyFile

• copyFile(sourceFileName, destFileName): void

• Copies an existing file to a new file. Overwriting a file of the same name is not allowed.

  Parameters

  • sourceFileName: FilePath

    The file to copy.
  • destFileName: FilePath

    The name of the destination file. This cannot be a directory or an existing file.

  Returns void

StaticcopyFileToPath

• copyFileToPath(source, destination): void

• Copies a file from one path to another, while creating any parent directories if they don't already exist.

  Parameters

  • source: FilePath

    Path to the file to copy.
  • destination: FilePath

    Path to the copied file.

  Returns void

StaticcreateDirectory

• createDirectory(path): boolean

• Creates all directories and subdirectories in the specified path unless they already exist.

  Parameters

  • path: FilePath

    The directory to create.

  Returns boolean

  True upon success.

StaticdeleteDirectory

• deleteDirectory(path, recursive): void

• Deletes the specified directory and, if indicated, any subdirectories and files in the directory.

  Parameters

  • path: FilePath

    The name of the directory to remove.
  • recursive: boolean

    true to remove directories, subdirectories, and files in path; otherwise, false.

  Returns void

StaticdeleteFile

• deleteFile(path): void

• Deletes the specified file.

  Parameters

  • path: FilePath

    The name of the file to be deleted. Wildcard characters are not supported.

  Returns void

StaticensureConsistentPathSeparators

• ensureConsistentPathSeparators(path): FilePath

• Ensures that the given path directory separators are consistent to the current platform.

  Parameters

  • path: string | FilePath

  Returns FilePath

StaticensurePrefix

• ensurePrefix(path, prefix): FilePath

• Ensures that the given path starts with the given prefix. Same path if already does.

  Parameters

  • path: string | FilePath

    The path to check the suffix for.
  • prefix: string | FilePath

    The prefix to add to the path if not yet present.

  Returns FilePath

  The given path prefixed with the given prefix. The same path if already contains the given suffix.

StaticensureSuffix

• ensureSuffix(path, suffix): FilePath

• Ensures that the given path ends with the given suffix. Same path if already does.

  Parameters

  • path: string | FilePath

    The path to check the suffix for.
  • suffix: string | FilePath

    The suffix to add to the path if not yet present.

  Returns FilePath

  The given path suffixed with the given suffix. The same path if already contains the given suffix.

StaticgetCurrentDirectory

• getCurrentDirectory(): FilePath

• Gets the current working directory of the application.

  Returns FilePath

  A string that contains the path of the current working directory, and does not end with a backslash ().

StaticgetDirectoriesInFolder

• getDirectoriesInFolder(filePath, recursive): FilePath[]

• Returns an array of directory names in a specified path.

  Parameters

  • filePath: FilePath

    The relative or absolute path to the directory to search. This string is not case-sensitive.
  • recursive: boolean

  Returns FilePath[]

  An array of the full names (including paths) for the directories in the directory specified by path.

StaticgetExtension

• getExtension(path): string

• Returns the extension of the specified path string.

  Parameters

  • path: string | FilePath

    The path string from which to obtain the file name and extension.

  Returns string

  The extension of the specified path (including the period "."), or null, or System.String.Empty.

StaticgetFileName

• getFileName(path): FilePath

• Returns the file name and extension of the specified path string.

  Parameters

  • path: string | FilePath

    The path of the file.

  Returns FilePath

  The characters after the last directory character in path.

StaticgetFileNameWithoutExtension

• getFileNameWithoutExtension(path): string

• Returns the file name of the specified path string without the extension.

  Parameters

  • path: string | FilePath

    The path of the file.

  Returns string

  The string returned by System.IO.Path.GetFileName(System.String), minus the last period (.) and all characters following it.

StaticgetFilesInFolder

• getFilesInFolder(filePath, recursive): FilePath[]

• Returns an array of file names in a specified path.

  Parameters

  • filePath: string | FilePath

    The relative or absolute path to the directory to search. This string is not case-sensitive.
  • recursive: boolean

  Returns FilePath[]

  An array of the full names (including paths) for the files in the directory specified by path.

StaticgetFileSize

• getFileSize(filePath): number

• Gets the size of the file at the specified filePath.

  Parameters

  • filePath: FilePath

    The file to write to.

  Returns number

  The file size.

StaticgetLastDirectoryName

• getLastDirectoryName(path): string

• Returns name of the last directory specifier in given path, which is the name of parent directory of given file. If the path specifies a directory path, it should return name of that directory.

  Parameters

  • path: FilePath

    The path to transform.

  Returns string

  Name of directory specified in path.

StaticgetLastWriteTime

• getLastWriteTime(filepath): Date

• Returns the date and time the specified file or directory was last written to.

  Parameters

  • filepath: FilePath

    The file or directory for which to obtain write date and time information.

  Returns Date

  A Date object set to the date and time that the specified file or directory was last written to. This value is expressed in local time.

StaticgetParentIdentifierPath

• getParentIdentifierPath(path): FilePath

• Returns the parent of the provided path.

  Parameters

  • path: string | FilePath

    Path to return the parent of.

  Returns FilePath

  Parent of the path. This usually means the folder containing the file or folder in the current path.

StaticgetPathWithoutFilename

• getPathWithoutFilename(path): FilePath

• Removes the filename component from the path string.

  Parameters

  • path: string | LibraryIdentifierPath | FilePath

    The path of a file or directory.

  Returns FilePath

  Path without the filename component.

StaticgetTail

• getTail(path): string

• Returns the last entry in the path, regardless if that is a directory or a filename.

  Parameters

  • path: string | FilePath

    Path to get the tail of.

  Returns string

  Tail of the path. This might be a directory or a filename.

StaticgetTailWithSeparator

• getTailWithSeparator(path): string

• Similar to getTail, but when the given path is a path to a directory, the returned value also contains a separator char at the end to indicate that.

  Parameters

  • path: string | FilePath

    Path to get the tail of.

  Returns string

  Tail of the path. This might be a directory or a filename.

StaticisDirectory

• isDirectory(path): boolean

• Returns whether or not the given path is pointing to a directory.

  Parameters

  • path: string | FilePath

    The path to check for.

  Returns boolean

  True for directory and false for files/resources.

StaticisExistingDirectory

• isExistingDirectory(path): boolean

• Determines whether the given path refers to an existing directory on disk.

  Parameters

  • path: string | FilePath

    The path to test.

  Returns boolean

  true if path refers to an existing directory; false if the directory does not exist or an error occurs

StaticisExistingFile

• isExistingFile(path): boolean

• Determines whether the specified file exists.

  Parameters

  • path: string | FilePath

    The file to check.

  Returns boolean

  true if the caller has the required permissions and path contains the name of an existing file; otherwise, false.

StaticisFile

• isFile(path): boolean

• Returns whether or not the given path represents a file or a Resource.

  Parameters

  • path: FilePath

    The path to check for.

  Returns boolean

  True for files and resources. False for a directory.

StaticisPathPartOf

• isPathPartOf(path, parent): boolean

• Checks if one path is part of an another path.

  Parameters

  • path: string | FilePath

    Path to check if it's part of parent.
  • parent: string | FilePath

    Parent that might contain path.

  Returns boolean

  True if parent contains path.

StaticisPathRooted

• isPathRooted(path): boolean

• Gets a value indicating whether the specified path string contains a root.

  Parameters

  • path: string | FilePath

    The path to test.

  Returns boolean

  true if path contains a root; otherwise, false.

StaticisValidFileName

• isValidFileName(name): boolean

• Checks if the provided name can be used as a file name.

  Parameters

  • name: string

    Name to check.

  Returns boolean

  True if the name can be used as a file name.

StaticmoveDirectory

• moveDirectory(source, destination): void

• Moves a directory from one path to another, while creating any parent directories if they don't already exist.

  Parameters

  • source: FilePath

    Path to the directory to move.
  • destination: FilePath

    New location and/or name of the directory.

  Returns void

StaticmoveFile

• moveFile(source, destination): void

• Moves a file from one path to another, while creating any parent directories if they don't already exist.

  Parameters

  • source: FilePath

    Path to the file to move.
  • destination: FilePath

    New location and/or name of the file.

  Returns void

StaticreadAllBytes

• readAllBytes(path): number[]

• Opens a binary file, reads the contents of the file into a byte array, and then closes the file.

  Parameters

  • path: FilePath

    The file to open for reading.

  Returns number[]

  A byte array containing the contents of the file.

StaticreadAllText

• readAllText(path): string

• Opens a text file, reads all lines of the file, and then closes the file.

  Parameters

  • path: FilePath

    The file to open for reading.

  Returns string

  A string containing all lines of the file.

StaticwriteAllBytes

• writeAllBytes(path, bytes): void

• Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten.

  Parameters

  • path: FilePath

    The file to write to.
  • bytes: number[]

  Returns void

  The bytes to write to the file.

StaticwriteAllStream

• writeAllStream(filePath, stream, seekToBeginning?): boolean

• Creates a new file, writes the specified stream to the file, and then closes the file. If the target file already exists, it is overwritten.

  Parameters

  • filePath: FilePath

    The file to write to.
  • stream: DataStream

    The stream to write to the file.
  • OptionalseekToBeginning: boolean

    If true, seeks the stream to be beginning.

  Returns boolean

StaticwriteAllText

• writeAllText(filePath, contents): boolean

• Creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten.

  Parameters

  • filePath: FilePath

    The file to write to.
  • contents: string

    The string to write to the file.

  Returns boolean