Class FileSystemInternal

Utility class for dealing with files.

Hierarchy

  • FrameworkObject
    • FileSystemInternal

Constructors

constructor

Methods

copy createDir ensureDirectoryExists exists getApplicationDataDirectoryPath getContentsOfFile getDataDirectoryPath getDirectoriesInFolder getExecutablePath getFilesInFolder getFileSize getFrameworkLibraryDirectoryPath getLastModifiedTime getTempDirectoryPath getUserDataDirectoryPath getUserDocumentsDirectoryPath getWorkingDirectoryPath isDirectory isDirectoryWritable isFile move remove writeContentsToFile writeStreamToFile

Constructors

Protectedconstructor

Methods

Staticcopy

  • copy(oldPath, newPath, overwriteExisting?): 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

StaticcreateDir

  • createDir(fullPath): void

  • Creates a folder at the specified path.

    Parameters

    • fullPath: FilePath

      Full path to a full folder to create.

    Returns void

StaticensureDirectoryExists

  • 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

Staticexists

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

StaticgetApplicationDataDirectoryPath

  • getApplicationDataDirectoryPath(): FilePath

  • Returns the path to the application data directory folder.

    Returns FilePath

StaticgetContentsOfFile

  • getContentsOfFile(filePath): string

  • Reads all text from the specified filePath.

    Parameters

    Returns string

StaticgetDataDirectoryPath

  • getDataDirectoryPath(): FilePath

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

    Returns FilePath

StaticgetDirectoriesInFolder

  • getDirectoriesInFolder(filePath, recursive): 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.

StaticgetExecutablePath

  • getExecutablePath(): FilePath

  • Returns the path to the currently running executable.

    Returns FilePath

StaticgetFilesInFolder

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

StaticgetFileSize

  • getFileSize(fullPath): number

  • Returns the size of a file in bytes.

    Parameters

    Returns number

StaticgetFrameworkLibraryDirectoryPath

  • getFrameworkLibraryDirectoryPath(): FilePath

  • Returns the path to the framework library directory.

    Returns FilePath

StaticgetLastModifiedTime

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

StaticgetTempDirectoryPath

  • getTempDirectoryPath(): FilePath

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

    Returns FilePath

StaticgetUserDataDirectoryPath

  • getUserDataDirectoryPath(): FilePath

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

    Returns FilePath

StaticgetUserDocumentsDirectoryPath

  • getUserDocumentsDirectoryPath(): FilePath

  • Returns the path to the current user system documents folder.

    Returns FilePath

StaticgetWorkingDirectoryPath

  • getWorkingDirectoryPath(): FilePath

  • Returns the path to the currently working directory.

    Returns FilePath

StaticisDirectory

  • isDirectory(fullPath): boolean

  • Returns true if a folder exists at the specified path.

    Parameters

    • fullPath: FilePath

      Full path to a file or folder.

    Returns boolean

StaticisDirectoryWritable

  • isDirectoryWritable(directoryPath): boolean

  • Returns whether the given directory (if exists) is writable.

    Parameters

    Returns boolean

StaticisFile

  • isFile(fullPath): boolean

  • Returns true if a file exists at the specified path.

    Parameters

    • fullPath: FilePath

      Full path to a file or folder.

    Returns boolean

Staticmove

  • move(oldPath, newPath, overwriteExisting?): 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

Staticremove

  • remove(fullPath, recursively?): 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.

StaticwriteContentsToFile

  • writeContentsToFile(filePath, contents): boolean

  • Writes the text contents to the specified filePath.

    Parameters

    Returns boolean

StaticwriteStreamToFile

  • writeStreamToFile(filePath, contents, seekToBeginning?): boolean

  • Writes the text contents to the specified filePath.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Methods