Class PreloadFile<FS>

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

Type Parameters

FS extends FileSystem

Hierarchy (view full)

File
- PreloadFile
  - NoSyncFile

Index

Constructors

constructor

new PreloadFile<FS>(fs, path, flag, stats, _buffer?): PreloadFile<FS>
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
- FS extends FileSystem
Parameters
- fs: FS
  The file system that created the file.
- path: string
  Path to the file
- flag: string
- stats: 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.
- _buffer: Uint8Array = ...
Returns PreloadFile<FS>
Overrides File.constructor
- Defined in src/file.ts:355

Properties

`Protected` _buffer

_buffer: Uint8Array = ...

`Protected` _position

_position: number = 0

Current position

`Protected` closed

closed: boolean = false

Whether the file is open or closed

`Protected` dirty

dirty: boolean = false

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

`Readonly` flag

flag: string

`Protected` fs

fs: FS

The file system that created the file.

`Readonly` path

path: string

Path to the file

`Readonly` stats

stats: 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.

Accessors

buffer

get buffer(): Uint8Array
Get the underlying buffer for this file. Mutating not recommended and will mess up dirty tracking.

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

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.
Overrides File.position
- Defined in src/file.ts:402
set position(newPos): void
Set the file position.
Parameters
- newPos: number
  new position
Returns void
Overrides File.position
- Defined in src/file.ts:413

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Overrides File.[asyncDispose]
- Defined in src/file.ts:750

[dispose]

[dispose](): void
Returns void
Overrides File.[dispose]
- Defined in src/file.ts:754

`Protected` _read

_read(buffer, offset?, length?, position?): number
Parameters
- buffer: ArrayBufferView
- offset: number = 0
- length: number = ...
- Optional position: number
Returns number
- Defined in src/file.ts:600

_setType

_setType(type): Promise<void>
Internal
Set the file type
Parameters
- type: FileType
Returns Promise<void>
Overrides File._setType
- Defined in src/file.ts:732

_setTypeSync

_setTypeSync(type): void
Internal
Set the file type
Parameters
- type: FileType
Returns void
Overrides File._setTypeSync
- Defined in src/file.ts:741

`Protected` _truncate

_truncate(length): void
Parameters
- length: number
Returns void
- Defined in src/file.ts:495

`Protected` _write

_write(buffer, offset?, length?, position?): number
Parameters
- buffer: Uint8Array
- offset: number = 0
- length: number = ...
- position: number = ...
Returns number
- Defined in src/file.ts:533

chmod

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

chmodSync

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

chown

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

chownSync

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

close

close(): Promise<void>
Asynchronous close.

Returns Promise<void>
Overrides File.close
- Defined in src/file.ts:439

closeSync

closeSync(): void
Synchronous close.

Returns void
Overrides File.closeSync
- Defined in src/file.ts:447

datasync

datasync(): Promise<void>
Asynchronous datasync.

Default implementation maps to sync.

Returns Promise<void>
Inherited from File.datasync
- Defined in src/file.ts:266

datasyncSync

datasyncSync(): void
Synchronous datasync.

Default implementation maps to syncSync.

Returns void
Inherited from File.datasyncSync
- Defined in src/file.ts:275

`Protected` dispose

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

read

read<TBuffer>(buffer, offset?, length?, position?): Promise<{
buffer: TBuffer;
bytesRead: number;
}>
Read data from the file.
Type Parameters
- TBuffer extends ArrayBufferView
Parameters
- buffer: TBuffer
  The buffer that the data will be written to.
- Optional offset: number
  The offset within the buffer where writing will start.
- Optional length: number
  An integer specifying the number of bytes to read.
- Optional 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<{
buffer: TBuffer;
bytesRead: number;
}>
Overrides File.read
- Defined in src/file.ts:635

readSync

readSync(buffer, offset?, length?, position?): number
Read data from the file.
Parameters
- buffer: ArrayBufferView
  The buffer that the data will be written to.
- Optional offset: number
  The offset within the buffer where writing will start.
- Optional length: number
  An integer specifying the number of bytes to read.
- Optional 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
Overrides File.readSync
- Defined in src/file.ts:652

stat

stat(): Promise<Stats>
Asynchronous stat.

Returns Promise<Stats>
Overrides File.stat
- Defined in src/file.ts:478

statSync

statSync(): Stats
Synchronous stat.

Returns Stats
Overrides File.statSync
- Defined in src/file.ts:488

sync

sync(): Promise<void>
Asynchronous sync.

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

syncSync

syncSync(): void
Synchronous sync.

Returns void
Overrides File.syncSync
- Defined in src/file.ts:428

truncate

truncate(length): Promise<void>
Asynchronous truncate.
Parameters
- length: number
Returns Promise<void>
Overrides File.truncate
- Defined in src/file.ts:519

truncateSync

truncateSync(length): void
Synchronous truncate.
Parameters
- length: number
Returns void
Overrides File.truncateSync
- Defined in src/file.ts:528

utimes

utimes(atime, mtime): Promise<void>
Change the file timestamps of the file.
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>
Overrides File.utimes
- Defined in src/file.ts:712

utimesSync

utimesSync(atime, mtime): void
Change the file timestamps of the file.
Parameters
- atime: Date
- mtime: Date
Returns void
Overrides File.utimesSync
- Defined in src/file.ts:722

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
  Uint8Array containing the data to write to the file.
- Optional offset: number
  Offset in the buffer to start reading data from.
- Optional length: number
  The amount of bytes to write to the file.
- Optional 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>
Overrides File.write
- Defined in src/file.ts:575

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
  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
Overrides File.writeSync
- Defined in src/file.ts:594

Class PreloadFile<FS>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PreloadFile<FS>

Properties

Protected _buffer

Protected _position

Protected closed

Protected dirty

Readonly flag

Protected fs

Readonly path

Readonly stats

Accessors

buffer

Returns Uint8Array

position

Returns number

Parameters

Returns void

Methods

[asyncDispose]

Returns Promise<void>

[dispose]

Returns void

Protected _read

Parameters

Returns number

_setType

Parameters

Returns Promise<void>

_setTypeSync

Parameters

Returns void

Protected _truncate

Parameters

Returns void

Protected _write

Parameters

Returns number

chmod

Parameters

Returns Promise<void>

chmodSync

Parameters

Returns void

chown

Parameters

Returns Promise<void>

chownSync

Parameters

Returns void

close

Returns Promise<void>

closeSync

Returns void

datasync

Returns Promise<void>

datasyncSync

Returns void

Protected dispose

Parameters

Returns void

read

Type Parameters

Parameters

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

readSync

Parameters

Returns number

stat

`Protected` _buffer

`Protected` _position

`Protected` closed

`Protected` dirty

`Readonly` flag

`Protected` fs

`Readonly` path

`Readonly` stats

`Protected` _read

`Protected` _truncate

`Protected` _write

`Protected` dispose

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