Class FileSystemAccessFile

Hierarchy

PreloadFile<FileSystemAccessFileSystem>
- FileSystemAccessFile

Index

Constructors

Properties

_buffer _dirty _flag _fs _path _pos _stat

Constructors

constructor

new FileSystemAccessFile(_fs, _path, _flag, _stat, contents?): FileSystemAccessFile
Parameters
- _fs: FileSystemAccessFileSystem
- _path: string
- _flag: FileFlag
- _stat: Stats
- Optional contents: Uint8Array
Returns FileSystemAccessFile
Overrides PreloadFile<FileSystemAccessFileSystem>.constructor
- Defined in src/backends/FileSystemAccess.ts:31

Properties

`Protected` _buffer

_buffer: Uint8Array

`Protected` _dirty

_dirty: boolean

`Protected` _flag

_flag: FileFlag

`Protected` _fs

_fs: FileSystemAccessFileSystem

`Protected` _path

_path: string

`Protected` _pos

_pos: number

`Protected` _stat

_stat: Stats

Methods

advancePos

advancePos(delta): number
Advance the current file position by the indicated number of positions.
Parameters
- delta: number
Returns number
Inherited from PreloadFile.advancePos
- Defined in node_modules/@browserfs/core/dist/file.d.ts:297

chmod

chmod(mode): Promise<void>
Asynchronous fchmod.
Parameters
- mode: number
Returns Promise<void>
Inherited from PreloadFile.chmod
- Defined in node_modules/@browserfs/core/dist/file.d.ts:406

chmodSync

chmodSync(mode): void
Synchronous fchmod.
Parameters
- mode: number
Returns void
Inherited from PreloadFile.chmodSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:411

chown

chown(uid, gid): Promise<void>
Asynchronous fchown.
Parameters
- uid: number
- gid: number
Returns Promise<void>
Inherited from PreloadFile.chown
- Defined in node_modules/@browserfs/core/dist/file.d.ts:417

chownSync

chownSync(uid, gid): void
Synchronous fchown.
Parameters
- uid: number
- gid: number
Returns void
Inherited from PreloadFile.chownSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:423

close

close(): Promise<void>
Returns Promise<void>
Overrides PreloadFile.close
- Defined in src/backends/FileSystemAccess.ts:42

closeSync

closeSync(): void
Core: Synchronous close.

Returns void
Inherited from PreloadFile.closeSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:322

datasync

datasync(): Promise<void>
Returns Promise<void>
Inherited from PreloadFile.datasync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:228

datasyncSync

datasyncSync(): void
Returns void
Inherited from PreloadFile.datasyncSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:229

getBuffer

getBuffer(): Uint8Array
NONSTANDARD: Get the underlying buffer for this file. !!DO NOT MUTATE!! Will mess up dirty tracking.

Returns Uint8Array
Inherited from PreloadFile.getBuffer
- Defined in node_modules/@browserfs/core/dist/file.d.ts:272

getFlag

getFlag(): FileFlag
Returns FileFlag
Inherited from PreloadFile.getFlag
- Defined in node_modules/@browserfs/core/dist/file.d.ts:277

getPath

getPath(): string
Get the path to this file.

Returns string
[String] The path to the file.
Inherited from PreloadFile.getPath
- Defined in node_modules/@browserfs/core/dist/file.d.ts:282

getPos

getPos(): 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
[Number] The current file position.
Inherited from PreloadFile.getPos
- Defined in node_modules/@browserfs/core/dist/file.d.ts:292

getStats

getStats(): Stats
NONSTANDARD: Get underlying stats for this file. !!DO NOT MUTATE!!

Returns Stats
Inherited from PreloadFile.getStats
- Defined in node_modules/@browserfs/core/dist/file.d.ts:276

`Protected` isDirty

isDirty(): boolean
Returns boolean
Inherited from PreloadFile.isDirty
- Defined in node_modules/@browserfs/core/dist/file.d.ts:424

read

read(buffer, offset, length, position): Promise<{
buffer: Uint8Array;
bytesRead: number;
}>
Read data from the file.
Parameters
- buffer: Uint8Array
- offset: number
- length: number
- position: number
Returns Promise<{
buffer: Uint8Array;
bytesRead: number;
}>
Inherited from PreloadFile.read
- Defined in node_modules/@browserfs/core/dist/file.d.ts:385

readSync

readSync(buffer, offset, length, position): number
Read data from the file.
Parameters
- buffer: Uint8Array
- offset: number
- length: number
- position: number
Returns number
[Number]
Inherited from PreloadFile.readSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:401

`Protected` resetDirty

resetDirty(): void
Resets the dirty bit. Should only be called after a sync has completed successfully.

Returns void
Inherited from PreloadFile.resetDirty
- Defined in node_modules/@browserfs/core/dist/file.d.ts:428

setPos

setPos(newPos): number
Set the file position.
Parameters
- newPos: number
Returns number
Inherited from PreloadFile.setPos
- Defined in node_modules/@browserfs/core/dist/file.d.ts:302

stat

stat(): Promise<Stats>
Asynchronous stat.

Returns Promise<Stats>
Inherited from PreloadFile.stat
- Defined in node_modules/@browserfs/core/dist/file.d.ts:327

statSync

statSync(): Stats
Synchronous stat.

Returns Stats
Inherited from PreloadFile.statSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:331

sync

sync(): Promise<void>
Returns Promise<void>
Overrides PreloadFile.sync
- Defined in src/backends/FileSystemAccess.ts:35

syncSync

syncSync(): void
Core: Synchronous sync.

Returns void
Inherited from PreloadFile.syncSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:312

truncate

truncate(len): Promise<void>
Asynchronous truncate.
Parameters
- len: number
Returns Promise<void>
Inherited from PreloadFile.truncate
- Defined in node_modules/@browserfs/core/dist/file.d.ts:337

truncateSync

truncateSync(len): void
Synchronous truncate.
Parameters
- len: number
Returns void
Inherited from PreloadFile.truncateSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:342

utimes

utimes(atime, mtime): Promise<void>
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>
Inherited from PreloadFile.utimes
- Defined in node_modules/@browserfs/core/dist/file.d.ts:234

utimesSync

utimesSync(atime, mtime): void
Parameters
- atime: Date
- mtime: Date
Returns void
Inherited from PreloadFile.utimesSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:235

write

write(buffer, offset, length, position): Promise<number>
Write buffer to the file. Note that it is unsafe to use fs.write multiple times on the same file without waiting for the callback.
Parameters
- buffer: Uint8Array
- offset: number
- length: number
- position: number
Returns Promise<number>
Inherited from PreloadFile.write
- Defined in node_modules/@browserfs/core/dist/file.d.ts:357

writeSync

writeSync(buffer, offset, length, position): number
Write buffer to the file. Note that it is unsafe to use fs.writeSync multiple times on the same file without waiting for the callback.
Parameters
- buffer: Uint8Array
- offset: number
- length: number
- position: number
Returns number
[Number]
Inherited from PreloadFile.writeSync
- Defined in node_modules/@browserfs/core/dist/file.d.ts:371

Generated using TypeDoc