Class FileSystem

constructor

• new FileSystem(): FileSystem

  Returns FileSystem

StaticaltDirectorySeparatorChar

StaticdirectorySeparatorChar

Static ReadonlypackageFileExtension

StaticposixDirectorySeparatorChar

StaticwindowsDirectorySeparatorChar

StaticchangeExtension

• changeExtension<
      T extends string
      | LibraryIdentifierPath
      | LibraryPath
      | FilePath,
  >(
      path: T,
      extension: string,
  ): T

  Changes the extension of a path string.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    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 T

  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 extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path1: T,
      path2: string | T,
  ): T

  Combines two strings into a path.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path1: T

    The first path to combine.

  • path2: string | T

    The second path to combine.

  Returns T

  The combined paths.

StaticcomparePaths

• comparePaths<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      a: T,
      b: T,
  ): boolean

  Checks if two paths are equal.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • a: T

    First path.

  • b: T

    Second path.

  Returns boolean

  True if both paths point to the same place.

StaticcopyDirectoryRecursive

• copyDirectoryRecursive(source: FilePath, destination: FilePath): 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: FilePath, destFileName: FilePath): 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: FilePath, destination: FilePath): 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: FilePath): 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: FilePath, recursive: boolean): 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: FilePath): 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<
      T extends string
      | LibraryIdentifierPath
      | LibraryPath
      | FilePath,
  >(
      path: T,
  ): T

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

  Returns T

StaticensureDirectoryExists

• ensureDirectoryExists(fullPath: FilePath): boolean

  Creates a folder at the specified path if it does not exist yet.

  Parameters

  • fullPath: FilePath

    Full path to a full folder to create.

  Returns boolean

  True if the directory exists or was created, false if the directory couldn't be created

StaticensurePrefix

• ensurePrefix<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path: T,
      prefix: string | T,
  ): T

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    The path to check the suffix for.

  • prefix: string | T

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

  Returns T

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

StaticensureSuffix

• ensureSuffix<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path: T,
      suffix: string | T,
  ): T

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    The path to check the suffix for.

  • suffix: string | T

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

  Returns T

  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: FilePath, recursive: boolean): 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 | FilePath): 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<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path: T,
  ): T

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    The path of the file.

  Returns T

  The characters after the last directory character in path.

StaticgetFileNameWithoutExtension

• getFileNameWithoutExtension<
      T extends string
      | LibraryIdentifierPath
      | LibraryPath
      | FilePath,
  >(
      path: T,
  ): T

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    The path of the file.

  Returns T

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

StaticgetFilesInFolder

• getFilesInFolder(filePath: string | FilePath, recursive: boolean): 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: 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.

StaticgetLastWriteTime

• getLastWriteTime(filepath: 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<T extends string | LibraryIdentifierPath | LibraryPath>(
      path: T,
  ): T

  Returns the parent of the provided path.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath

  Parameters

  • path: T

    Path to return the parent of.

  Returns T

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

StaticgetPathWithoutFilename

• getPathWithoutFilename<
      T extends string
      | LibraryIdentifierPath
      | LibraryPath
      | FilePath,
  >(
      path: T,
  ): T

  Removes the filename component from the path string.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    The path of a file or directory.

  Returns T

  Path without the filename component.

StaticgetTail

• getTail<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path: T,
  ): string

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    Path to get the tail of.

  Returns string

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

StaticgetTailWithSeparator

• getTailWithSeparator<
      T extends string
      | LibraryIdentifierPath
      | LibraryPath
      | FilePath,
  >(
      path: T,
  ): T

  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.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    Path to get the tail of.

  Returns T

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

StaticisDirectory

• isDirectory<T extends string | FilePath>(path: T): boolean

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

  Type Parameters

  • T extends string | FilePath

  Parameters

  • path: T

    The path to check for.

  Returns boolean

  True for directory and false for files/resources.

StaticisExistingDirectory

• isExistingDirectory(path: string | FilePath): 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: string | FilePath): 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<T extends string | FilePath>(path: T): boolean

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

  Type Parameters

  • T extends string | FilePath

  Parameters

  • path: T

    The path to check for.

  Returns boolean

  True for files and resources. False for a directory.

StaticisPathPartOf

• isPathPartOf<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path: T,
      parent: T,
  ): boolean

  Checks if one path is part of an another path.

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    Path to check if it's part of parent.

  • parent: T

    Parent that might contain path.

  Returns boolean

  True if parent contains path.

StaticisPathRooted

• isPathRooted<T extends string | LibraryIdentifierPath | LibraryPath | FilePath>(
      path: T,
  ): boolean

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • path: T

    The path to test.

  Returns boolean

  true if path contains a root; otherwise, false.

StaticisReadOnly

• isReadOnly(path: FilePath): boolean

  Determines if the file has the read-only flag set.

  Parameters

  • path: FilePath

  Returns boolean

StaticisValidFileName

• isValidFileName<
      T extends string
      | LibraryIdentifierPath
      | LibraryPath
      | FilePath,
  >(
      name: T,
  ): boolean

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

  Type Parameters

  • T extends string | LibraryIdentifierPath | LibraryPath | FilePath

  Parameters

  • name: T

    Name to check.

  Returns boolean

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

StaticmoveDirectory

• moveDirectory(source: FilePath, destination: FilePath): 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: FilePath, destination: FilePath): 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: FilePath): 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: FilePath): 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.

StaticsetReadOnly

• setReadOnly(path: FilePath, isReadOnly: boolean, isRecursive?: boolean): boolean

  Sets the read-only state of the file.

  Parameters

  • path: FilePath
  • isReadOnly: boolean
  • OptionalisRecursive: boolean

  Returns boolean

StaticwriteAllBytes

• writeAllBytes(path: FilePath, bytes: number[]): 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: FilePath,
      stream: DataStream,
      seekToBeginning?: boolean,
  ): 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

StaticwriteAllStreamAsync

• writeAllStreamAsync(
      filePath: FilePath,
      stream: DataStream,
      seekToBeginning?: boolean,
  ): UncertainAsyncOp<boolean>

  Creates a new file, asynchronously 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 UncertainAsyncOp<boolean>

StaticwriteAllText

• writeAllText(filePath: FilePath, contents: string): 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