Class File

Hierarchy (View Summary)

File
- UploadedFile

Constructors

`Protected`constructor

new File(path: string, checkPath?: boolean): File
Create a File.
Parameters
- path: string
  The file path.
- checkPath: boolean = true
  Whether to check if the file path is valid.
Returns File

Methods

edit

edit(callback: (content: string) => string): this
Edit file content.
Parameters
- callback: (content: string) => string
  The callback function to modify the file content.
Returns this
The current File instance.

exists

exists(): boolean

Check if the file exists.

Returns boolean
True if the file exists, otherwise false.

getAbsolutePath

getAbsolutePath(root?: string): string
Get the absolute file path.
Parameters
- root: string = ''
  The root directory to resolve from.
Returns string
The absolute file path.

getATime

getATime(): StatTimeMs

Get the last access time of the file.

Returns StatTimeMs
The last access time in milliseconds.

getBasename

getBasename(exclude?: string): string
Get the basename of the file.
Parameters
- exclude: string = ''
  The file extension to exclude from the basename.
Returns string
The basename of the file.

getBuffer

getBuffer(): Buffer

Get the raw file content as a Buffer (binary-safe).

Returns Buffer
The content of the file as a Buffer.

Throws
FilesystemError if the file cannot be read.

getContent

getContent(encoding?: BufferEncoding): string
Get file content.
Parameters
- encoding: BufferEncoding = 'utf-8'
Returns string
The content of the file as a string.

getCTime

getCTime(): StatTimeMs

Get the created time of the file.

Returns StatTimeMs
The created time in milliseconds.

getDirname

getDirname(): string

Get the directory name of the file.

Returns string
The directory name.

getEncodedAbsolutePath

getEncodedAbsolutePath(root?: string): string
Get the encoded absolute file path.
Parameters
- root: string = ''
  The root directory to resolve from.
Returns string
The encoded absolute file path.

getEncodedPath

getEncodedPath(): string

Get the encoded file path.

Returns string
The encoded file path.

getExtension

getExtension(): string

Get the file extension.

Returns string
The file extension.

getFilename

getFilename(): string

Get the filename of the file.

Returns string
The filename of the file.

getHashedContent

getHashedContent(algo?: string): string
Get the hashed content of the file.
Parameters
- algo: string = 'sha256'
  The hashing algorithm to use.
Returns string
The hashed content of the file as a hex string.

getMimeType

getMimeType(): string

Get the MIME type of the file.

Returns string
The MIME type of the file.
getMimeType(fallback: string): string
Get the MIME type of the file.
Parameters
- fallback: string
  A fallback MIME type if detection fails.
Returns string
The MIME type of the file.

getMTime

getMTime(): StatTimeMs

Get the last modified time of the file.

Returns StatTimeMs
The last modified time in milliseconds.

getName

getName(): string

Get the name of the file without extension.

Returns string
The name of the file.

getPath

getPath(): string

Get the file path.

Returns string
The file path.

getSize

getSize(formatted?: boolean): string | StatTimeMs
Get file size.
Parameters
- formatted: boolean = false
  Whether to return the file size as a formatted string.
Returns string | StatTimeMs
The file size as a string or number.

isAbsolute

isAbsolute(): boolean

Check if the file path is absolute.

Returns boolean
True if the file path is absolute, otherwise false.

isCompressed

isCompressed(extensions?: string[]): boolean
Check if the file is compressed.
Parameters
- extensions: string[] = ...
Returns boolean
True if the file is compressed, otherwise false.

isDir

isDir(): boolean

Check if the file is a directory.

Returns boolean
True if the file is a directory, otherwise false.

isExecutable

isExecutable(): boolean

Check if the file is executable.

Returns boolean
True if the file is executable, otherwise false.

isFile

isFile(): boolean

Check if the file is a regular file.

Returns boolean
True if the file is a regular file, otherwise false.

isLink

isLink(): boolean

Check if the file is a symbolic link.

Returns boolean
True if the file is a symbolic link, otherwise false.

isPathPrefix

isPathPrefix(prefix: string): boolean
Check if the file path starts with a provided prefix.
Parameters
- prefix: string
Returns boolean
True if the file path starts with the provided prefix, otherwise false.

isReadable

isReadable(): boolean

Check if the file is readable.

Returns boolean
True if the file is readable, otherwise false.

isWritable

isWritable(): boolean

Check if the file is writable.

Returns boolean
True if the file is writable, otherwise false.

move

move(directory: string, name?: string): File
Move file to a new directory.
Parameters
- directory: string
  The target directory.
- Optionalname: string
  The new name for the file.
Returns File
The new File instance representing the moved file.

Throws
FileError if the file could not be moved.

remove

remove(force?: boolean): this
Remove file.
Parameters
- force: boolean = false
  Whether to forcefully remove the file.
Returns this
The current File instance.

write

write(content: string | Buffer<ArrayBufferLike>): this
Write content to file (creating it if it does not exist).
Parameters
- content: string | Buffer<ArrayBufferLike>
  The content to write to the file.
Returns this
The current File instance.

Throws
FilesystemError if the content cannot be written.

`Static`create

create(path: string, checkPath?: boolean): File
Create a File.
Parameters
- path: string
  The file path.
- checkPath: boolean = true
  Whether to check if the file path is valid.
Returns File
A new File instance.