Private
coreCompresses the Files at the given paths
An array of Paths to Compress
The Directory to write the Compressed Files to
⚠️ The resulting file appears to be unpredictably named?
"Unexpected response code, Compress may not have succeeded" If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the source or destination path did not exist or was not Compressable
Copies the File at the given path
The full path to the File to Copy
⚠️ New copy will be written to the same directory, with a name such as test.txt
-> test.txt copy-1643810941850
"Unexpected response code, Copy may not have succeeded" If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the file path didn't exist or wasn't copyable.
Creates a Directory with the given path
The full path to the new Directory
⚠️ This will silently fail if the given path is present and invalid or unreachable ⚠️ This is always relative to the Server's default directory (usually /home/container)
Decompresses the File at the given path
The full path to the File to Decompress
"Unexpected response code, Decompress may not have succeeded" If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the given path did not exist or was not reachable
Deletes the Files at all of the given paths
An array of File Paths to Delete
"Unexpected response code, Delete may not have succeeded" If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the file path didn't exist or wasn't deleteable.
Get the Contents of the given Directory
The path to list
Retrieves the contents of the File at the given path
The full path to the File to read (After the /home/container/ part)
"Server returned error code: {number}" This error is often thrown if the given path doesn't exist, or is not readable. The error code would be 404.
Renames (or moves) the given File
The full path to the File
The new path of the File
"Unexpected response code, Rename may not have succeeded" If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the source or destination path did not exist or was not reachable
Writes the given content to the File at the given path
The full path to the File
The full content of the File
⚠️ Overwrites the file if it already exists ⚠️ This function silently fails if the target path is not writeable
Generated using TypeDoc
Handles interaction with the Server's File System