Class NoSyncFile<T>

For the file systems which do not sync to anything.

Type Parameters

T extends FileSystem

Hierarchy (view full)

PreloadFile<T>
- NoSyncFile

Index

Constructors

Properties

_buffer _position closed dirty flag fs path stats

Accessors

buffer position

Constructors

constructor

new NoSyncFile<T>(fs, path, flag, stats, _buffer?): NoSyncFile<T>
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
- T extends FileSystem
Parameters
- fs: T
- path: string
- flag: string
- stats: Stats
- _buffer: Uint8Array = ...
  A buffer containing the entire contents of the file.
Returns NoSyncFile<T>
Inherited from PreloadFile.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

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
Inherited from PreloadFile.buffer
- 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.
Inherited from PreloadFile.position
- Defined in src/file.ts:324
set position(value): void
Get the current file position.
Parameters
- value: number
Returns void
Inherited from PreloadFile.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
Inherited from PreloadFile._read
- Defined in src/file.ts:500

`Protected`_truncate

_truncate(length): void
Parameters
- length: number
Returns void
Inherited from PreloadFile._truncate
- 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
Inherited from PreloadFile._write
- Defined in src/file.ts:436

[asyncDispose]

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

[dispose]

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

chmod

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

chmodSync

chmodSync(mode): void
Parameters
- mode: number
Returns void
Inherited from PreloadFile.chmodSync
- Defined in src/file.ts:568

chown

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

chownSync

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

close

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

closeSync

closeSync(): void
Returns void
Overrides PreloadFile.closeSync
- Defined in src/file.ts:630

datasync

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

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

datasyncSync

datasyncSync(): void
Default implementation maps to syncSync.

Returns void
Inherited from PreloadFile.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
Inherited from PreloadFile.dispose
- 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;
}>
Inherited from PreloadFile.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
Inherited from PreloadFile.readSync
- Defined in src/file.ts:553

stat

stat(): Promise<Stats>
Returns Promise<Stats>
Inherited from PreloadFile.stat
- Defined in src/file.ts:392

statSync

statSync(): Stats
Returns Stats
Inherited from PreloadFile.statSync
- Defined in src/file.ts:399

sync

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

syncSync

syncSync(): void
Returns void
Overrides PreloadFile.syncSync
- Defined in src/file.ts:624

truncate

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

truncateSync

truncateSync(length): void
Parameters
- length: number
Returns void
Inherited from PreloadFile.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>
Inherited from PreloadFile.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
Inherited from PreloadFile.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>
Inherited from PreloadFile.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
Inherited from PreloadFile.writeSync
- Defined in src/file.ts:494