io/files
Documentation
- source: io/files.ts
Overview
Classes
Files
exists()
Checks if a file or directory exists at the given path.
tsstatic exists(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if the path exists, false otherwise.
isExecutable()
Checks if the file or directory at the given path is executable.
tsstatic isExecutable(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if executable, false otherwise.
isReadable()
Checks if the file or directory at the given path is readable.
tsstatic isReadable(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if readable, false otherwise.
isWritable()
Checks if the file or directory at the given path is writable.
tsstatic isWritable(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if writable, false otherwise.
isHidden()
Checks if the file or directory at the given path is hidden.
tsstatic isHidden(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if hidden, false otherwise.
isDirectory()
Checks if the path refers to a directory.
tsstatic isDirectory(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if it's a directory, false otherwise.
isFile()
Checks if the path refers to a regular file.
tsstatic isFile(path: string): boolean;
Parameter Type Description pathstringThe path to check. Returns
- Type:
boolean- Description: True if it's a file, false otherwise.
isSameFile()
Checks if two paths refer to the same underlying file system object.
tsstatic isSameFile(path1: string, path2: string): boolean;
Parameter Type Description path1stringThe first path. path2stringThe second path. Returns
- Type:
boolean- Description: True if they reference the same file/directory, false otherwise.
getCanonicalPath()
Returns the canonical (absolute and normalized) path for the given path.
tsstatic getCanonicalPath(path: string): string;
Parameter Type Description pathstringThe path to normalize. Returns
- Type:
string- Description: The canonical path string.
getName()
Gets the simple name of the file or directory at the given path (the last element).
tsstatic getName(path: string): string;
Parameter Type Description pathstringThe path. Returns
- Type:
string- Description: The name.
getParentPath()
Gets the path of the parent directory.
tsstatic getParentPath(path: string): string;
Parameter Type Description pathstringThe path. Returns
- Type:
string- Description: The parent path string, or null/empty if none exists.
readBytes()
Reads all bytes from a file into a JavaScript byte array (an array of numbers).
Note: This method automatically converts the native Java byte array to a JavaScript array using `Bytes.toJavaScriptBytes()`.
tsstatic readBytes(path: string): void;
Parameter Type Description pathstringThe path to the file. Returns
- Type:
void- Description: A JavaScript array of byte values.
readBytesNative()
Reads all bytes from a file and returns the native Java byte array object.
tsstatic readBytesNative(path: string): void;
Parameter Type Description pathstringThe path to the file. Returns
- Type:
void- Description: The native Java byte array.
readText()
Reads all text content from a file using the platform's default character encoding.
tsstatic readText(path: string): string;
Parameter Type Description pathstringThe path to the file. Returns
- Type:
string- Description: The content of the file as a string.
writeBytes()
Writes the content of a JavaScript byte array to a file. Overwrites existing content.
Note: This method automatically converts the JavaScript array to a native Java byte array using `Bytes.toJavaBytes()` before writing.
tsstatic writeBytes(path: string, data: any): void;
Parameter Type Description pathstringThe path to the file. dataanyThe JavaScript array of byte values to write. Returns
- Type:
void- Description:
writeBytesNative()
Writes the content of a native Java byte array to a file. Overwrites existing content.
tsstatic writeBytesNative(path: string, data: any): void;
Parameter Type Description pathstringThe path to the file. dataanyThe native Java byte array to write. Returns
- Type:
void- Description:
writeText()
Writes a string of text to a file using the platform's default character encoding. Overwrites existing content.
tsstatic writeText(path: string, text: string): void;
Parameter Type Description pathstringThe path to the file. textstringThe string content to write. Returns
- Type:
void- Description:
getLastModified()
Gets the last modified time of the file or directory.
tsstatic getLastModified(path: string): Date;
Parameter Type Description pathstringThe path to the file or directory. Returns
- Type:
Date- Description: A JavaScript Date object representing the last modified time.
setLastModified()
Sets the last modified time of the file or directory.
tsstatic setLastModified(path: string, time: Date): void;
Parameter Type Description pathstringThe path to the file or directory. timeDateThe new Date object to set as the last modified time. Returns
- Type:
void- Description:
getOwner()
Gets the owner of the file or directory.
tsstatic getOwner(path: string): string;
Parameter Type Description pathstringThe path to the file or directory. Returns
- Type:
string- Description: The owner name as a string.
setOwner()
Sets the owner of the file or directory.
tsstatic setOwner(path: string, owner: string): void;
Parameter Type Description pathstringThe path to the file or directory. ownerstringThe new owner name. Returns
- Type:
void- Description:
getPermissions()
Gets the permissions string for the file or directory (implementation dependent).
tsstatic getPermissions(path: string): string;
Parameter Type Description pathstringThe path to the file or directory. Returns
- Type:
string- Description: The permissions string.
setPermissions()
Sets the permissions for the file or directory (implementation dependent).
tsstatic setPermissions(path: string, permissions: string): void;
Parameter Type Description pathstringThe path to the file or directory. permissionsstringThe permissions string. Returns
- Type:
void- Description:
size()
Gets the size of the file in bytes.
tsstatic size(path: string): number;
Parameter Type Description pathstringThe path to the file. Returns
- Type:
number- Description: The size in bytes.
createFile()
Creates a new, empty file at the specified path.
tsstatic createFile(path: string): void;
Parameter Type Description pathstringThe path where the file should be created. Returns
- Type:
void- Description:
createDirectory()
Creates a new directory at the specified path.
tsstatic createDirectory(path: string): void;
Parameter Type Description pathstringThe path where the directory should be created. Returns
- Type:
void- Description:
copy()
Copies a file or directory from a source path to a target path.
tsstatic copy(source: string, target: string): void;
Parameter Type Description sourcestringThe source path. targetstringThe target path. Returns
- Type:
void- Description:
move()
Moves or renames a file or directory.
tsstatic move(source: string, target: string): void;
Parameter Type Description sourcestringThe source path. targetstringThe target path. Returns
- Type:
void- Description:
deleteFile()
Deletes the file at the specified path.
tsstatic deleteFile(path: string): void;
Parameter Type Description pathstringThe path to the file to delete. Returns
- Type:
void- Description:
deleteDirectory()
Deletes the directory at the specified path.
tsstatic deleteDirectory(path: string, forced: boolean): void;
Parameter Type Description pathstringThe path to the directory to delete. forcedbooleanIf true, recursively deletes the directory and its contents. Returns
- Type:
void- Description:
createTempFile()
Creates a new temporary file with the given prefix and suffix.
tsstatic createTempFile(prefix: string, suffix: string): string;
Parameter Type Description prefixstringThe prefix string to be used in generating the file's name. suffixstringThe suffix string to be used in generating the file's name. Returns
- Type:
string- Description: The path of the created temporary file.
createTempDirectory()
Creates a new temporary directory with the given prefix.
tsstatic createTempDirectory(prefix: string): string;
Parameter Type Description prefixstringThe prefix string to be used in generating the directory's name. Returns
- Type:
string- Description: The path of the created temporary directory.
createInputStream()
Creates and returns a new InputStream for reading data from the file.
tsstatic createInputStream(path: string): InputStream;
Parameter Type Description pathstringThe path to the file. Returns
- Type:
InputStream- Description: A new InputStream instance.
createOutputStream()
Creates and returns a new OutputStream for writing data to the file.
tsstatic createOutputStream(path: string): OutputStream;
Parameter Type Description pathstringThe path to the file. Returns
- Type:
OutputStream- Description: A new OutputStream instance.
traverse()
Traverses a directory and returns a structured FolderObject hierarchy.
tsstatic traverse(path: string): void;
Parameter Type Description pathstringThe path to the folder to traverse. Returns
- Type:
void- Description: The root FolderObject containing the file system tree structure.
list()
Lists the direct children (files and folders) of a directory, returning only their paths.
tsstatic list(path: string): void;
Parameter Type Description pathstringThe path to the directory. Returns
- Type:
void- Description: An array of string paths for the contents of the directory.
find()
Finds files and directories matching a specified glob pattern within a directory tree.
tsstatic find(path: string, pattern: string): void;
Parameter Type Description pathstringThe starting path for the search. patternstringThe glob pattern to match (e.g., "*.js", "**.txt"). Returns
- Type:
void- Description: An array of string paths that match the pattern.