Class PreloadFile<FS>

An implementation of File that operates completely in-memory. PreloadFiles are backed by a Uint8Array.

Type Parameters

FS extends FileSystem

Hierarchy (view full)

File<FS>
- PreloadFile
  - NoSyncFile

Index

Constructors

constructor

new PreloadFile<FS>(fs, path, flag, stats, _buffer?): PreloadFile<FS>
Creates a file with 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
- path: string
- flag: string
- stats: Stats
- _buffer: Uint8Array = ...
  A buffer containing the entire contents of the file.
Returns PreloadFile<FS>
Overrides File.constructor
- Defined in src/file.ts:280

Properties

`Protected`_buffer

_buffer: Uint8Array = ...

A buffer containing the entire contents of the file.

`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

`Internal`fs

fs: FileSystem

The file system that created the file

`Readonly`path

path: string

`Readonly`stats

stats: Stats

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:311

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:324
set position(value): void
Get the current file position.
Parameters
- value: number
Returns void
Overrides File.position
- Defined in src/file.ts:331

Methods

`Protected`_read

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

`Protected`_truncate

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

`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:436

[asyncDispose]

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

[dispose]

[dispose](): void
Returns void
Inherited from File.[dispose]
- Defined in src/file.ts:173

chmod

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

chmodSync

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

chown

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

chownSync

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

close

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

closeSync

closeSync(): void
Returns void
Overrides File.closeSync
- Defined in src/file.ts:365

datasync

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

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

datasyncSync

datasyncSync(): void
Default implementation maps to syncSync.

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

`Protected`dispose

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

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.
- Optionaloffset: number
  The offset within the buffer where writing will start.
- Optionallength: number
  An integer specifying the number of bytes to read.
- Optionalposition: 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:538

readSync

readSync(buffer, offset?, length?, position?): number
Read data from the file.
Parameters
- buffer: ArrayBufferView
  The buffer that the data will be written to.
- Optionaloffset: number
  The offset within the buffer where writing will start.
- Optionallength: number
  An integer specifying the number of bytes to read.
- Optionalposition: 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:553

stat

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

statSync

statSync(): Stats
Returns Stats
Overrides File.statSync
- Defined in src/file.ts:399

sync

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

syncSync

syncSync(): void
Returns void
Overrides File.syncSync
- Defined in src/file.ts:346

truncate

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

truncateSync

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

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:595

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:605

write

write(buffer, offset?, length?, position?): Promise<number>
Write buffer to the file.
Parameters
- buffer: Uint8Array
  Uint8Array containing the data to write to the file.
- Optionaloffset: number
  Offset in the buffer to start reading data from.
- Optionallength: number
  The amount of bytes to write to the file.
- Optionalposition: 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:479

writeSync

writeSync(buffer, offset?, length?, position?): 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
Overrides File.writeSync
- Defined in src/file.ts:494

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

Protectedclosed

Protecteddirty

Readonlyflag

Internalfs

Readonlypath

Readonlystats

Accessors

buffer

Returns Uint8Array

position

Returns number

Parameters

Returns void

Methods

Protected_read

Parameters

Returns number

Protected_truncate

Parameters

Returns void

Protected_write

Parameters

Returns number

[asyncDispose]

Returns Promise<void>

[dispose]

Returns void

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

Protecteddispose

Parameters

Returns void

read

Type Parameters

Parameters

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

readSync

Parameters

Returns number

stat

Returns Promise<Stats>

statSync

Returns Stats

sync

Returns Promise<void>

syncSync

`Protected`_buffer

`Protected`_position

`Protected`closed

`Protected`dirty

`Readonly`flag

`Internal`fs

`Readonly`path

`Readonly`stats

`Protected`_read

`Protected`_truncate

`Protected`_write

`Protected`dispose

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