Class FileSystem

Utility class providing synchronous and asynchronous file system operations specifically tailored for the worker environment (e.g., managing temp folders, downloading remote files).

Index

Constructors

Methods

downloadFile getInfo makeFolder prepare removeFolder safeString uploadFile

Constructors

constructor

new FileSystem(): FileSystem
Returns FileSystem

Methods

`Static`downloadFile

downloadFile(url: string, filepath: string): Promise<unknown>
Downloads a file from an external HTTP/HTTPS URL into the local filesystem.
Parameters
- url: string
  The remote resource URL.
- filepath: string
  The local destination path.
Returns Promise<unknown>
A promise resolving when the download finishes.

Throws
If the HTTP request or stream fails.
- Defined in worker/src/FileSystem.ts:71

`Static`getInfo

getInfo(file: string): Promise<any>
Return meta data on given file
Parameters
- file: string
Returns Promise<any>
- Defined in worker/src/FileSystem.ts:151

`Static`makeFolder

makeFolder(folder: string): void
Synchronously creates a single directory.
Parameters
- folder: string
  The directory path.
Returns void
- Defined in worker/src/FileSystem.ts:34

`Static`prepare

prepare(folder: string): void
Prepares a clean processing directory, creating it along with required subdirectories (images, vecto). Any existing folder with the same name will be deleted first.
Parameters
- folder: string
  The base directory path to set up.
Returns void
- Defined in worker/src/FileSystem.ts:20

`Static`removeFolder

removeFolder(folder: string, recursively?: boolean): void
Recursively and synchronously removes a folder and its entire contents.
Parameters
- folder: string
  The target directory to destroy.
- recursively: boolean = true
  Whether to traverse and delete nested folders. Defaults to true.
Returns void
Throws
If recursively is false but nested folders are encountered.
- Defined in worker/src/FileSystem.ts:45

`Static`safeString

safeString(name: string): string
Sanitizes a string to be used safely as a filename by replacing spaces with underscores.
Parameters
- name: string
  The original string.
Returns string
The sanitized string.
- Defined in worker/src/FileSystem.ts:97

`Static`uploadFile

uploadFile(filename: string, meta: FileType, mime?: string): Promise<FileType>
Upload file to public URL and return meta data
Parameters
- filename: string
  string
- meta: FileType
- mime: string = 'video/mp4'
Returns Promise<FileType>
Promise
- Defined in worker/src/FileSystem.ts:108