Class FileRW

Read-write file handle. Extends FileRO with write and truncate capabilities.

Hierarchy (View Summary)

FileRO
- FileRW

Index

Constructors

Properties

Methods

close flush getSize read truncate write

Constructors

constructor

new FileRW(fullPath: string): FileRW
Parameters
- fullPath: string
Returns FileRW
Inherited from FileRO.constructor
- Defined in src/sync-file.ts:107

Properties

`Readonly`fullPath

fullPath: string

Methods

close

close(): Promise<void>
Close the file handle.

Returns Promise<void>
Inherited from FileRO.close
- Defined in src/sync-file.ts:134

flush

flush(): Promise<void>
Flush pending writes to the file.

Returns Promise<void>
- Defined in src/sync-file.ts:177

getSize

getSize(): Promise<number>
Get file size in bytes.

Returns Promise<number>
Inherited from FileRO.getSize
- Defined in src/sync-file.ts:129

read

read(
size: number | BufferSource,
options?: { at?: number },
): Promise<ArrayBuffer>
Read data from the file.
Parameters
- size: number | BufferSource
  Number of bytes or a preallocated buffer.
- Optionaloptions: { at?: number }
  Optional at offset to read from.
Returns Promise<ArrayBuffer>
A Promise resolving to an ArrayBuffer of read data.
Inherited from FileRO.read
- Defined in src/sync-file.ts:117

truncate

truncate(newSize: number): Promise<void>
Truncate the file to a specified size.
Parameters
- newSize: number
  New size of the file in bytes.
Returns Promise<void>
- Defined in src/sync-file.ts:171

write

write(data: string | BufferSource, options?: { at?: number }): Promise<number>
Write data to the file.
Parameters
- data: string | BufferSource
  String or buffer to write.
- Optionaloptions: { at?: number }
  Optional at offset to write at.
Returns Promise<number>
Number of bytes written.
- Defined in src/sync-file.ts:153