Class Handle`Internal`

Index

Constructors

Properties

_buffer? _position closed context dirty flag fs inode internalPath path

Accessors

_isSync isClosed position

Constructors

constructor

new Handle(
    context: V_Context,
    path: string,
    fs: FileSystem,
    internalPath: string,
    flag: number,
    inode: InodeLike,
): Handle
Creates a file with path and, optionally, the given contents. Note that, if contents is specified, it will be mutated by the file.
Parameters
- context: V_Context
- path: string
- fs: FileSystem
- internalPath: string
- flag: number
- inode: InodeLike
Returns Handle
- Defined in src/vfs/file.ts:62

Properties

`Protected` `Optional`_buffer

_buffer?: Uint8Array<ArrayBufferLike>

`Protected`_position

_position: number = 0

Current position

`Protected`closed

closed: boolean = false

Whether the file is open or closed

`Readonly`context

context: V_Context

`Protected`dirty

dirty: boolean = false

Whether the file has changes which have not been written to the FS

`Readonly`flag

flag: number

`Readonly`fs

`Readonly`inode

inode: InodeLike

`Readonly`internalPath

internalPath: string

`Readonly`path

path: string

Accessors

`Protected`_isSync

get _isSync(): boolean
Returns boolean
- Defined in src/vfs/file.ts:71

isClosed

get isClosed(): boolean
Returns boolean
- Defined in src/vfs/file.ts:54

position

get position(): number
Get the current file position.

We emulate the following bug mentioned in the Node documentation:

On Linux, positional writes don't work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to the end of the file.

Returns number
The current file position.
- Defined in src/vfs/file.ts:36
set position(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vfs/file.ts:40

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
- Defined in src/vfs/file.ts:219

[dispose]

"[dispose]"(): void
Returns void
- Defined in src/vfs/file.ts:75

chmod

chmod(mode: number): Promise<void>
Parameters
- mode: number
Returns Promise<void>
- Defined in src/vfs/file.ts:348

chmodSync

chmodSync(mode: number): void
Parameters
- mode: number
Returns void
- Defined in src/vfs/file.ts:193

chown

chown(uid: number, gid: number): Promise<void>
Parameters
- uid: number
- gid: number
Returns Promise<void>
- Defined in src/vfs/file.ts:355

chownSync

chownSync(uid: number, gid: number): void
Parameters
- uid: number
- gid: number
Returns void
- Defined in src/vfs/file.ts:200

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/vfs/file.ts:240

closeSync

closeSync(): void
Returns void
- Defined in src/vfs/file.ts:96

datasync

datasync(): Promise<void>
Default implementation maps to sync.

Returns Promise<void>
- Defined in src/vfs/file.ts:236

datasyncSync

datasyncSync(): void
Default implementation maps to syncSync.

Returns void
- Defined in src/vfs/file.ts:92

`Protected`dispose

dispose(force?: boolean): void
Cleans up. This will not sync the file data to the FS
Parameters
- Optionalforce: boolean
Returns void
- Defined in src/vfs/file.ts:249

`Protected`disposeSync

disposeSync(force?: boolean): void
Cleans up. This will not sync the file data to the FS
Parameters
- Optionalforce: boolean
Returns void
- Defined in src/vfs/file.ts:105

read

read(
    buffer: ArrayBufferView,
    offset?: number,
    length?: number,
    position?: number,
): Promise<number>
Read data from the file.
Parameters
- buffer: ArrayBufferView
  The buffer that the data will be written to.
- offset: number = 0
  The offset within the buffer where writing will start.
- length: number = ...
  An integer specifying the number of bytes to read.
- position: number = ...
  An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
Returns Promise<number>
number of bytes written
- Defined in src/vfs/file.ts:323

readSync

readSync(
    buffer: ArrayBufferView,
    offset?: number,
    length?: number,
    position?: number,
): number
Read data from the file.
Parameters
- buffer: ArrayBufferView
  The buffer that the data will be written to.
- offset: number = 0
  The offset within the buffer where writing will start.
- length: number = ...
  An integer specifying the number of bytes to read.
- position: number = ...
  An integer specifying where to begin reading from in the file. If position is null, data will be read from the current file position.
Returns number
number of bytes written
- Defined in src/vfs/file.ts:168

stat

stat(): InodeLike
Returns InodeLike
- Defined in src/vfs/file.ts:256

streamRead

streamRead(options: StreamOptions): ReadableStream
Create a stream for reading the file.
Parameters
- options: StreamOptions
Returns ReadableStream
- Defined in src/vfs/file.ts:377

streamWrite

streamWrite(options: StreamOptions): WritableStream
Create a stream for writing the file.
Parameters
- options: StreamOptions
Returns WritableStream
- Defined in src/vfs/file.ts:386

sync

sync(): Promise<void>
Returns Promise<void>
- Defined in src/vfs/file.ts:223

syncSync

syncSync(): void
Returns void
- Defined in src/vfs/file.ts:79

truncate

truncate(length: number): Promise<void>
Parameters
- length: number
Returns Promise<void>
- Defined in src/vfs/file.ts:262

truncateSync

truncateSync(length: number): void
Parameters
- length: number
Returns void
- Defined in src/vfs/file.ts:112

utimes

utimes(atime: number, mtime: number): Promise<void>
Change the file timestamps of the file.
Parameters
- atime: number
- mtime: number
Returns Promise<void>
- Defined in src/vfs/file.ts:365

utimesSync

utimesSync(atime: number, mtime: number): void
Change the file timestamps of the file.
Parameters
- atime: number
- mtime: number
Returns void
- Defined in src/vfs/file.ts:210

write

write(
    buffer: Uint8Array,
    offset?: number,
    length?: number,
    position?: number,
): Promise<number>
Write buffer to the file.
Parameters
- buffer: Uint8Array
  Uint8Array containing the data to write to the file.
- offset: number = 0
  Offset in the buffer to start reading data from.
- length: number = ...
  The amount of bytes to write to the file.
- position: number = ...
  Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
Returns Promise<number>
bytes written
- Defined in src/vfs/file.ts:286

writeSync

writeSync(
    buffer: Uint8Array,
    offset?: number,
    length?: number,
    position?: number,
): number
Write buffer to the file.
Parameters
- buffer: Uint8Array
  Uint8Array containing the data to write to the file.
- offset: number = 0
  Offset in the buffer to start reading data from.
- length: number = ...
  The amount of bytes to write to the file.
- position: number = ...
  Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
Returns number
bytes written
- Defined in src/vfs/file.ts:136