Class FileHandle

File handle object (based on file descriptor)

Warning

Resource management warning:

Must call close() explicitly, otherwise file descriptor will leak
Unclosed files are closed synchronously during GC, which may block the event loop

Index

Constructors

Properties

[toStringTag] path

Methods

chmod chown close datasync fileno read stat sync truncate utime write

Constructors

constructor

new FileHandle(): FileHandle
Returns FileHandle

Properties

`Readonly`[toStringTag]

"[toStringTag]": "FileHandle"

`Readonly`path

path: string

File path (passed during creation)

Methods

chmod

chmod(mode: number): Promise<void>
Change file permissions (e.g., 0o644)
Parameters
- mode: number
Returns Promise<void>

chown

chown(uid: number, gid: number): Promise<void>
Change file owner and group
Parameters
- uid: number
- gid: number
Returns Promise<void>

close

close(): void
Close file (force release resource)

Returns void

datasync

datasync(): Promise<void>
Sync file data to disk (excluding metadata)

Returns Promise<void>

fileno

fileno(): number
Get underlying file descriptor (for debugging)

Returns number

read

read(
buffer: CModuleAsyncFS.Uint8Array,
position?: number | null,
): Promise<number>
Read data from file (async)
Parameters
- buffer: CModuleAsyncFS.Uint8Array
  Buffer to write data into (will be modified)
- Optionalposition: number | null
  File read position, null means current offset
Returns Promise<number>
Actual bytes read, 0 indicates EOF

Throws
position < 0

stat

stat(): Promise<StatResult>
Get file metadata (async)

Returns Promise<StatResult>

sync

sync(): Promise<void>
Sync file data to disk (including metadata)

Returns Promise<void>

truncate

truncate(offset?: number): Promise<void>
Truncate file to specified size
Parameters
- Optionaloffset: number
Returns Promise<void>

utime

utime(atime: number, mtime: number): Promise<void>
Change file access and modification times
Parameters
- atime: number
- mtime: number
Returns Promise<void>

write

write(
buffer: CModuleAsyncFS.Uint8Array,
position?: number | null,
): Promise<number>
Write data to file (async)
Parameters
- buffer: CModuleAsyncFS.Uint8Array
  Data to write
- Optionalposition: number | null
  File write position, null means current offset
Returns Promise<number>
Actual bytes written

Throws
position < 0