Class FileSystem

The FileSystem class provides static methods for the manipulation of files and filepaths.

Constructors

constructor

new FileSystem(): FileSystem
Returns FileSystem

Properties

`Static`kAltDirectorySeparatorChar

kAltDirectorySeparatorChar: FilePath

Provides a platform-specific alternate character used to separate directory levels in a path string that reflects a hierarchical file system organization.

`Static`kDirectorySeparatorChar

kDirectorySeparatorChar: FilePath

Provides a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization.

`Static`kPosixDirectorySeparatorChar

kPosixDirectorySeparatorChar: FilePath

Provides a character used to separate directory levels in a path string that reflects a hierarchical file system organization on POSIX systems.

`Static`kWindowsDirectorySeparatorChar

kWindowsDirectorySeparatorChar: FilePath

Provides a character used to separate directory levels in a path string that reflects a hierarchical file system organization on Windows systems.

`Static` `Readonly`packageFileExtension

packageFileExtension = ".rpak"

The file extension for the RSX package format. The string includes the dot filename separate.

Methods

`Static`changeExtension

changeExtension<T>(path, extension): T
Changes the extension of a path string.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | 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.

`Static`combinePaths

combinePaths<T>(path1, path2): T
Combines two strings into a path.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path1: T
  The first path to combine.
- path2: string | T
  The second path to combine.
Returns T
The combined paths.

`Static`comparePaths

comparePaths<T>(a, b): boolean
Checks if two paths are equal.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- a: T
  First path.
- b: T
  Second path.
Returns boolean
True if both paths point to the same place.

`Static`copyDirectoryRecursive

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

`Static`copyFile

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

`Static`copyFileToPath

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

`Static`createDirectory

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.

`Static`deleteDirectory

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

`Static`deleteFile

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

`Static`ensureConsistentPathSeparators

ensureConsistentPathSeparators<T>(path): T
Ensures that the given path directory separators are consistent to the current platform.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path: T
Returns T

`Static`ensureDirectoryExists

ensureDirectoryExists(fullPath): 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

`Static`ensurePrefix

ensurePrefix<T>(path, prefix): T
Ensures that the given path starts with the given prefix. Same path if already does.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | 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.

`Static`ensureSuffix

ensureSuffix<T>(path, suffix): T
Ensures that the given path ends with the given suffix. Same path if already does.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | 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.

`Static`getCurrentDirectory

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 ().

`Static`getDirectoriesInFolder

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.

`Static`getExtension

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.

`Static`getFileName

getFileName<T>(path): T
Returns the file name and extension of the specified path string.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path: T
  The path of the file.
Returns T
The characters after the last directory character in path.

`Static`getFileNameWithoutExtension

getFileNameWithoutExtension<T>(path): T
Returns the file name of the specified path string without the extension.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | 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.

`Static`getFilesInFolder

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.

`Static`getFileSize

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.

`Static`getLastWriteTime

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.

`Static`getParentIdentifierPath

getParentIdentifierPath<T>(path): T
Returns the parent of the provided path.
Type Parameters
- T extends string | IdentifierPath | LibraryIdentifierPath
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.

`Static`getPathWithoutFilename

getPathWithoutFilename<T>(path): T
Removes the filename component from the path string.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path: T
  The path of a file or directory.
Returns T
Path without the filename component.

`Static`getTail

getTail<T>(path): string
Returns the last entry in the path, regardless if that is a directory or a filename.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path: T
  Path to get the tail of.
Returns string
Tail of the path. This might be a directory or a filename.

`Static`getTailWithSeparator

getTailWithSeparator<T>(path): 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
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path: T
  Path to get the tail of.
Returns T
Tail of the path. This might be a directory or a filename.

`Static`isDirectory

isDirectory<T>(path): 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.

`Static`isExistingDirectory

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

`Static`isExistingFile

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.

`Static`isFile

isFile<T>(path): 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.

`Static`isPathPartOf

isPathPartOf<T>(path, parent): boolean
Checks if one path is part of an another path.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | 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.

`Static`isPathRooted

isPathRooted<T>(path): boolean
Gets a value indicating whether the specified path string contains a root.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- path: T
  The path to test.
Returns boolean
true if path contains a root; otherwise, false.

`Static`isReadOnly

isReadOnly(path): boolean
Determines if the file has the read-only flag set.
Parameters
- path: FilePath
Returns boolean

`Static`isValidFileName

isValidFileName<T>(name): boolean
Checks if the provided name can be used as a file name.
Type Parameters
- T extends
      | string
      | IdentifierPath
      | LibraryIdentifierPath
      | FilePath
Parameters
- name: T
  Name to check.
Returns boolean
True if the name can be used as a file name.

`Static`moveDirectory

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

`Static`moveFile

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

`Static`readAllBytes

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.

`Static`readAllText

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.

`Static`setReadOnly

setReadOnly(path, isReadOnly, isRecursive?): boolean
Sets the read-only state of the file.
Parameters
- path: FilePath
- isReadOnly: boolean
- OptionalisRecursive: boolean
Returns boolean

`Static`writeAllBytes

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.

`Static`writeAllStream

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

`Static`writeAllStreamAsync

writeAllStreamAsync(filePath, stream, seekToBeginning?): UncertainAsyncOp<boolean, string>
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, string>

`Static`writeAllText

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

Class FileSystem

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FileSystem

Properties

StatickAltDirectorySeparatorChar

StatickDirectorySeparatorChar

StatickPosixDirectorySeparatorChar

StatickWindowsDirectorySeparatorChar

Static ReadonlypackageFileExtension

Methods

StaticchangeExtension

Type Parameters

Parameters

Returns T

StaticcombinePaths

Type Parameters

Parameters

Returns T

StaticcomparePaths

Type Parameters

Parameters

Returns boolean

StaticcopyDirectoryRecursive

Parameters

Returns void

StaticcopyFile

Parameters

Returns void

StaticcopyFileToPath

Parameters

Returns void

StaticcreateDirectory

Parameters

Returns boolean

StaticdeleteDirectory

Parameters

Returns void

StaticdeleteFile

Parameters

Returns void

StaticensureConsistentPathSeparators

Type Parameters

Parameters

Returns T

StaticensureDirectoryExists

Parameters

Returns boolean

StaticensurePrefix

Type Parameters

Parameters

Returns T

StaticensureSuffix

Type Parameters

Parameters

Returns T

StaticgetCurrentDirectory

Returns FilePath

StaticgetDirectoriesInFolder

Parameters

Returns FilePath[]

StaticgetExtension

Parameters

Returns string

StaticgetFileName

Type Parameters

Parameters

Returns T

StaticgetFileNameWithoutExtension

Type Parameters

Parameters

Returns T

StaticgetFilesInFolder

Parameters

Returns FilePath[]

StaticgetFileSize

`Static`kAltDirectorySeparatorChar

`Static`kDirectorySeparatorChar

`Static`kPosixDirectorySeparatorChar

`Static`kWindowsDirectorySeparatorChar

`Static` `Readonly`packageFileExtension

`Static`changeExtension

`Static`combinePaths

`Static`comparePaths

`Static`copyDirectoryRecursive

`Static`copyFile

`Static`copyFileToPath

`Static`createDirectory

`Static`deleteDirectory

`Static`deleteFile

`Static`ensureConsistentPathSeparators

`Static`ensureDirectoryExists

`Static`ensurePrefix

`Static`ensureSuffix

`Static`getCurrentDirectory

`Static`getDirectoriesInFolder

`Static`getExtension

`Static`getFileName

`Static`getFileNameWithoutExtension

`Static`getFilesInFolder

`Static`getFileSize

`Static`getLastWriteTime

`Static`getParentIdentifierPath

`Static`getPathWithoutFilename

`Static`getTail

`Static`getTailWithSeparator

`Static`isDirectory

`Static`isExistingDirectory

`Static`isExistingFile

`Static`isFile

`Static`isPathPartOf

`Static`isPathRooted

`Static`isReadOnly

`Static`isValidFileName

`Static`moveDirectory

`Static`moveFile

`Static`readAllBytes

`Static`readAllText

`Static`setReadOnly

`Static`writeAllBytes

`Static`writeAllStream