Class FileSystemInternal

Utility class for dealing with files.

Constructors

`Protected`constructor

new FileSystemInternal(isInternalConstructor?: boolean): FileSystemInternal
Parameters
- OptionalisInternalConstructor: boolean
Returns FileSystemInternal

Overrides FrameworkObject.constructor

Methods

`Static`copy

copy(oldPath: FilePath, newPath: FilePath, overwriteExisting?: boolean): void
Makes a copy of a file or a folder in the specified path.
Parameters
- oldPath: FilePath
  Full path to the old file/folder.
- newPath: FilePath
  Full path to the new file/folder.
- OptionaloverwriteExisting: boolean
  (optional) If true, any existing file/folder at the new location will be overwritten, otherwise an exception will be thrown if a file/folder already exists.
Returns void

`Static`createDir

createDir(fullPath: FilePath): void
Creates a folder at the specified path.
Parameters
- fullPath: FilePath
  Full path to a full folder to create.
Returns void

`Static`ensureDirectoryExists

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

`Static`exists

exists(fullPath: FilePath): boolean
Returns true if a file or a folder exists at the specified path.
Parameters
- fullPath: FilePath
  Full path to a file or folder.
Returns boolean

`Static`getApplicationDataDirectoryPath

getApplicationDataDirectoryPath(): FilePath

Returns the path to the application data directory folder.

Returns FilePath

`Static`getContentsOfFile

getContentsOfFile(filePath: FilePath): string
Reads all text from the specified filePath.
Parameters
- filePath: FilePath
Returns string

`Static`getDataDirectoryPath

getDataDirectoryPath(): FilePath

Returns the path to the data directory (Currently working directory on Windows, AppName.app/Contents/Resources/ on MacOS).

Returns FilePath

`Static`getDirectoriesInFolder

getDirectoriesInFolder(filePath: FilePath, recursive: boolean): FilePath[]
Returns all diretories in the specified folder.
Parameters
- filePath: FilePath
  The root folder to search.
- recursive: boolean
  If false then only the direct children of the provided folder will be return, otherwise also includes entries from subfolders.
Returns FilePath[]
A list of all files.

`Static`getExecutablePath

getExecutablePath(): FilePath

Returns the path to the currently running executable.

Returns FilePath

`Static`getFilesInFolder

getFilesInFolder(filePath: FilePath, recursive: boolean): FilePath[]
Returns all files in the specified folder.
Parameters
- filePath: FilePath
  The root folder to search.
- recursive: boolean
  If false then only the direct children of the provided folder will be return, otherwise also includes entries from subfolders.
Returns FilePath[]
A list of all files.

`Static`getFileSize

getFileSize(fullPath: FilePath): number
Returns the size of a file in bytes.
Parameters
- fullPath: FilePath
  Full path to a file.
Returns number

`Static`getFrameworkLibraryDirectoryPath

getFrameworkLibraryDirectoryPath(): FilePath

Returns the path to the framework library directory.

Returns FilePath

`Static`getLastModifiedTime

getLastModifiedTime(fullPath: FilePath): number
Returns the last modified time of a file or a folder at the specified path.
Parameters
- fullPath: FilePath
  Full path to a file or a folder.
Returns number

`Static`getTempDirectoryPath

getTempDirectoryPath(): FilePath

Returns the path to a directory where temporary files may be stored.

Returns FilePath

`Static`getUserDataDirectoryPath

getUserDataDirectoryPath(): FilePath

Returns the path to a user directory where we can write persistent files. ex: Library/Application Support on MacOS

Returns FilePath

`Static`getUserDocumentsDirectoryPath

getUserDocumentsDirectoryPath(): FilePath

Returns the path to the current user system documents folder.

Returns FilePath

`Static`getWorkingDirectoryPath

getWorkingDirectoryPath(): FilePath

Returns the path to the currently working directory.

Returns FilePath

`Static`isDirectory

isDirectory(fullPath: FilePath): boolean
Returns true if a folder exists at the specified path.
Parameters
- fullPath: FilePath
  Full path to a file or folder.
Returns boolean

`Static`isDirectoryWritable

isDirectoryWritable(directoryPath: FilePath): boolean
Returns whether the given directory (if exists) is writable.
Parameters
- directoryPath: FilePath
Returns boolean

`Static`isFile

isFile(fullPath: FilePath): boolean
Returns true if a file exists at the specified path.
Parameters
- fullPath: FilePath
  Full path to a file or folder.
Returns boolean

`Static`isReadOnly

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

`Static`move

move(oldPath: FilePath, newPath: FilePath, overwriteExisting?: boolean): void
Moves a file or a folder from one to another path. This can also be used as a rename operation.
Parameters
- oldPath: FilePath
  Full path to the old file/folder.
- newPath: FilePath
  Full path to the new file/folder.
- OptionaloverwriteExisting: boolean
  (optional) If true, any existing file/folder at the new location will be overwritten, otherwise an exception will be thrown if a file/folder already exists.
Returns void

`Static`remove

remove(fullPath: FilePath, recursively?: boolean): boolean
Deletes a file or a folder at the specified path.
Parameters
- fullPath: FilePath
  Full path to a file or a folder..
- Optionalrecursively: boolean
  (optional) If true, folders will have their contents deleted as well. Otherwise an exception will be thrown for non-empty folders.
Returns boolean
True upon success.

`Static`setReadOnly

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

`Static`writeContentsToFile

writeContentsToFile(filePath: FilePath, contents: string): boolean
Writes the text contents to the specified filePath.
Parameters
- filePath: FilePath
- contents: string
Returns boolean

`Static`writeStreamToFile

writeStreamToFile(
    filePath: FilePath,
    contents: DataStream,
    seekToBeginning?: boolean,
): boolean
Writes the text contents to the specified filePath.
Parameters
- filePath: FilePath
- contents: DataStream
- OptionalseekToBeginning: boolean
Returns boolean

`Static`writeStreamToFileAsync

writeStreamToFileAsync(
    filePath: FilePath,
    contents: DataStream,
    seekToBeginning?: boolean,
): UncertainAsyncOp<boolean, string>
Asynchronously writes the text contents to the specified filePath.
Parameters
- filePath: FilePath
- contents: DataStream
- OptionalseekToBeginning: boolean
Returns UncertainAsyncOp<boolean, string>

Class FileSystemInternal

Index

Constructors

Methods

Constructors

Protectedconstructor

Parameters

Returns FileSystemInternal

Methods

Staticcopy

Parameters

Returns void

StaticcreateDir

Parameters

Returns void

StaticensureDirectoryExists

Parameters

Returns boolean

Staticexists

Parameters

Returns boolean

StaticgetApplicationDataDirectoryPath

Returns FilePath

StaticgetContentsOfFile

Parameters

Returns string

StaticgetDataDirectoryPath

Returns FilePath

StaticgetDirectoriesInFolder

Parameters

Returns FilePath[]

StaticgetExecutablePath

Returns FilePath

StaticgetFilesInFolder

Parameters

Returns FilePath[]

StaticgetFileSize

Parameters

Returns number

StaticgetFrameworkLibraryDirectoryPath

Returns FilePath

StaticgetLastModifiedTime

Parameters

Returns number

StaticgetTempDirectoryPath

Returns FilePath

StaticgetUserDataDirectoryPath

Returns FilePath

StaticgetUserDocumentsDirectoryPath

Returns FilePath

StaticgetWorkingDirectoryPath

Returns FilePath

StaticisDirectory

Parameters

Returns boolean

StaticisDirectoryWritable

Parameters

Returns boolean

StaticisFile

Parameters

Returns boolean

StaticisReadOnly

Parameters

Returns boolean

Staticmove

Parameters

Returns void

Staticremove

Parameters

Returns boolean

StaticsetReadOnly

Parameters

Returns boolean

StaticwriteContentsToFile

Parameters

Returns boolean

StaticwriteStreamToFile

Parameters

Returns boolean

StaticwriteStreamToFileAsync

`Protected`constructor

`Static`copy

`Static`createDir

`Static`ensureDirectoryExists

`Static`exists

`Static`getApplicationDataDirectoryPath

`Static`getContentsOfFile

`Static`getDataDirectoryPath

`Static`getDirectoriesInFolder

`Static`getExecutablePath

`Static`getFilesInFolder

`Static`getFileSize

`Static`getFrameworkLibraryDirectoryPath

`Static`getLastModifiedTime

`Static`getTempDirectoryPath

`Static`getUserDataDirectoryPath

`Static`getUserDocumentsDirectoryPath

`Static`getWorkingDirectoryPath

`Static`isDirectory

`Static`isDirectoryWritable

`Static`isFile

`Static`isReadOnly

`Static`move

`Static`remove

`Static`setReadOnly

`Static`writeContentsToFile

`Static`writeStreamToFile

`Static`writeStreamToFileAsync