Class PreloadFile<T>

An implementation of the File interface that operates on a file that is completely in-memory. PreloadFiles are backed by a Uint8Array.

This is also an abstract class, as it lacks an implementation of 'sync' and 'close'. Each filesystem that wishes to use this file representation must extend this class and implement those two methods.

Todo

'close' lever that disables functionality once closed.

Type Parameters

T extends FileSystem

Hierarchy

BaseFile
- PreloadFile

Index

Constructors

constructor

Properties

_buffer _dirty _flag _fs _path _pos _stat

Constructors

constructor

new PreloadFile<T>(_fs, _path, _flag, _stat, contents?): PreloadFile<T>
Creates a file with the given path and, optionally, the given contents. Note that, if contents is specified, it will be mutated by the file!
Type Parameters
- T extends FileSystem<T>
Parameters
- _fs: T
  
  The file system that created the file.
- _path: string
- _flag: FileFlag
- _stat: Stats
  
  The stats object for the given file. PreloadFile will mutate this object. Note that this object must contain the appropriate mode that the file was opened as.
- Optional contents: Uint8Array
  
  A buffer containing the entire contents of the file. PreloadFile will mutate this buffer. If not specified, we assume it is a new file.
Returns PreloadFile<T>
Overrides BaseFile.constructor
- Defined in src/file.ts:390

Properties

`Protected` _buffer

_buffer: Uint8Array

`Protected` _dirty

_dirty: boolean = false

`Protected` _flag

_flag: FileFlag

`Protected` _fs

_fs: T

`Protected` _path

_path: string

`Protected` _pos

_pos: number = 0

`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
- Defined in src/file.ts:452

chmod

chmod(mode): Promise<void>
Asynchronous fchmod.
Parameters
- mode: number
Returns Promise<void>
Overrides BaseFile.chmod
- Defined in src/file.ts:660

chmodSync

chmodSync(mode): void
Synchronous fchmod.
Parameters
- mode: number
Returns void
Overrides BaseFile.chmodSync
- Defined in src/file.ts:668

chown

chown(uid, gid): Promise<void>
Asynchronous fchown.
Parameters
- uid: number
- gid: number
Returns Promise<void>
Overrides BaseFile.chown
- Defined in src/file.ts:682

chownSync

chownSync(uid, gid): void
Synchronous fchown.
Parameters
- uid: number
- gid: number
Returns void
Overrides BaseFile.chownSync
- Defined in src/file.ts:691

close

close(): Promise<void>
Core: Asynchronous close. Must be implemented by subclasses of this class.

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

closeSync

closeSync(): void
Core: Synchronous close.

Returns void
- Defined in src/file.ts:492

datasync

datasync(): Promise<void>
Returns Promise<void>
Inherited from BaseFile.datasync
- Defined in src/file.ts:333

datasyncSync

datasyncSync(): void
Returns void
Inherited from BaseFile.datasyncSync
- Defined in src/file.ts:336

getBuffer

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

Returns Uint8Array
- Defined in src/file.ts:409

getFlag

getFlag(): FileFlag
Returns FileFlag
- Defined in src/file.ts:420

getPath

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

Returns string
[String] The path to the file.
- Defined in src/file.ts:428

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.
- Defined in src/file.ts:441

getStats

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

Returns Stats
- Defined in src/file.ts:416

`Protected` isDirty

isDirty(): boolean
Returns boolean
- Defined in src/file.ts:700

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;
}>
- Defined in src/file.ts:623

readSync

readSync(buffer, offset, length, position): number
Read data from the file.
Parameters
- buffer: Uint8Array
- offset: number
- length: number
- position: number
Returns number
[Number]
- Defined in src/file.ts:639

`Protected` resetDirty

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

Returns void
- Defined in src/file.ts:707

setPos

setPos(newPos): number
Set the file position.
Parameters
- newPos: number
Returns number
- Defined in src/file.ts:460

stat

stat(): Promise<Stats>
Asynchronous stat.

Returns Promise<Stats>
- Defined in src/file.ts:500

statSync

statSync(): Stats
Synchronous stat.

Returns Stats
- Defined in src/file.ts:507

sync

sync(): Promise<void>
Core: Asynchronous sync. Must be implemented by subclasses of this class.

Returns Promise<void>
Overrides BaseFile.sync
- Defined in src/file.ts:469

syncSync

syncSync(): void
Core: Synchronous sync.

Returns void
Overrides BaseFile.syncSync
- Defined in src/file.ts:476

truncate

truncate(len): Promise<void>
Asynchronous truncate.
Parameters
- len: number
Returns Promise<void>
- Defined in src/file.ts:516

truncateSync

truncateSync(len): void
Synchronous truncate.
Parameters
- len: number
Returns void
- Defined in src/file.ts:527

utimes

utimes(atime, mtime): Promise<void>
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>
Inherited from BaseFile.utimes
- Defined in src/file.ts:351

utimesSync

utimesSync(atime, mtime): void
Parameters
- atime: Date
- mtime: Date
Returns void
Inherited from BaseFile.utimesSync
- Defined in src/file.ts:354

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>
- Defined in src/file.ts:564

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]
- Defined in src/file.ts:581

Class PreloadFile<T>

Todo

Type Parameters

T extends FileSystem

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends FileSystem<T>

Parameters

_fs: T

_path: string

_flag: FileFlag

_stat: Stats

Optional contents: Uint8Array

Returns PreloadFile<T>

Properties

Protected _buffer

Protected _dirty

Protected _flag

Protected _fs

Protected _path

Protected _pos

Protected _stat

Methods

advancePos

Parameters

delta: number

Returns number

chmod

Parameters

mode: number

Returns Promise<void>

chmodSync

Parameters

mode: number

Returns void

chown

Parameters

uid: number

gid: number

Returns Promise<void>

chownSync

Parameters

uid: number

gid: number

Returns void

close

Returns Promise<void>

closeSync

Returns void

datasync

Returns Promise<void>

datasyncSync

Returns void

getBuffer

Returns Uint8Array

getFlag

Returns FileFlag

getPath

Returns string

getPos

Returns number

getStats

Returns Stats

Protected isDirty

Returns boolean

read

Parameters

buffer: Uint8Array

offset: number

length: number

position: number

Returns Promise<{ buffer: Uint8Array; bytesRead: number; }>

readSync

Parameters

`Optional` contents: Uint8Array

`Protected` _buffer

`Protected` _dirty

`Protected` _flag

`Protected` _fs

`Protected` _path

`Protected` _pos

`Protected` _stat

`Protected` isDirty

Returns Promise<{
buffer: Uint8Array;
bytesRead: number;
}>

`Protected` resetDirty