Class AsyncKeyValueFile

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.

Hierarchy

PreloadFile<AsyncKeyValueFileSystem>
- AsyncKeyValueFile

Implements

File

Index

Constructors

constructor

Properties

_buffer _dirty _flag _fs _path _pos _stat

Constructors

constructor

new AsyncKeyValueFile(_fs, _path, _flag, _stat, contents?): AsyncKeyValueFile
Parameters
- _fs: AsyncKeyValueFileSystem
- _path: string
- _flag: FileFlag
- _stat: Stats
- Optional contents: Uint8Array
Returns AsyncKeyValueFile
Overrides PreloadFile.constructor
- Defined in src/backends/AsyncStore.ts:164

Properties

`Protected` _buffer

_buffer: Uint8Array

`Protected` _dirty

_dirty: boolean = false

`Protected` _flag

_flag: FileFlag

`Protected` _fs

_fs: AsyncKeyValueFileSystem

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

chmod

chmod(mode): Promise<void>
Asynchronous fchmod.
Parameters
- mode: number
Returns Promise<void>
Implementation of File.chmod

Inherited from PreloadFile.chmod
- Defined in src/file.ts:660

chmodSync

chmodSync(mode): void
Synchronous fchmod.
Parameters
- mode: number
Returns void
Implementation of File.chmodSync

Inherited from PreloadFile.chmodSync
- Defined in src/file.ts:668

chown

chown(uid, gid): Promise<void>
Asynchronous fchown.
Parameters
- uid: number
- gid: number
Returns Promise<void>
Implementation of File.chown

Inherited from PreloadFile.chown
- Defined in src/file.ts:682

chownSync

chownSync(uid, gid): void
Synchronous fchown.
Parameters
- uid: number
- gid: number
Returns void
Implementation of File.chownSync

Inherited from PreloadFile.chownSync
- Defined in src/file.ts:691

close

close(): Promise<void>
Core: Asynchronous close.

Returns Promise<void>
Implementation of File.close

Overrides PreloadFile.close
- Defined in src/backends/AsyncStore.ts:178

closeSync

closeSync(): void
Core: Synchronous close.

Returns void
Implementation of File.closeSync

Inherited from PreloadFile.closeSync
- Defined in src/file.ts:492

datasync

datasync(): Promise<void>
Supplementary: Asynchronous datasync.

Default implementation maps to sync.

Returns Promise<void>
Implementation of File.datasync

Inherited from PreloadFile.datasync
- Defined in src/file.ts:333

datasyncSync

datasyncSync(): void
Supplementary: Synchronous datasync.

Default implementation maps to syncSync.

Returns void
Implementation of File.datasyncSync

Inherited from PreloadFile.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
Inherited from PreloadFile.getBuffer
- Defined in src/file.ts:409

getFlag

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

getPath

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

Returns string
[String] The path to the file.
Inherited from PreloadFile.getPath
- 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.
Implementation of File.getPos

Inherited from PreloadFile.getPos
- Defined in src/file.ts:441

getStats

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

Returns Stats
Inherited from PreloadFile.getStats
- Defined in src/file.ts:416

`Protected` isDirty

isDirty(): boolean
Returns boolean
Inherited from PreloadFile.isDirty
- 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;
}>
Implementation of File.read

Inherited from PreloadFile.read
- 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]
Implementation of File.readSync

Inherited from PreloadFile.readSync
- 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
Inherited from PreloadFile.resetDirty
- Defined in src/file.ts:707

setPos

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

stat

stat(): Promise<Stats>
Asynchronous stat.

Returns Promise<Stats>
Implementation of File.stat

Inherited from PreloadFile.stat
- Defined in src/file.ts:500

statSync

statSync(): Stats
Synchronous stat.

Returns Stats
Implementation of File.statSync

Inherited from PreloadFile.statSync
- Defined in src/file.ts:507

sync

sync(): Promise<void>
Core: Asynchronous sync.

Returns Promise<void>
Implementation of File.sync

Overrides PreloadFile.sync
- Defined in src/backends/AsyncStore.ts:168

syncSync

syncSync(): void
Core: Synchronous sync.

Returns void
Implementation of File.syncSync

Inherited from PreloadFile.syncSync
- Defined in src/file.ts:476

truncate

truncate(len): Promise<void>
Asynchronous truncate.
Parameters
- len: number
Returns Promise<void>
Implementation of File.truncate

Inherited from PreloadFile.truncate
- Defined in src/file.ts:516

truncateSync

truncateSync(len): void
Synchronous truncate.
Parameters
- len: number
Returns void
Implementation of File.truncateSync

Inherited from PreloadFile.truncateSync
- Defined in src/file.ts:527

utimes

utimes(atime, mtime): Promise<void>
Optional: Change the file timestamps of the file.
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>
Implementation of File.utimes

Inherited from PreloadFile.utimes
- Defined in src/file.ts:351

utimesSync

utimesSync(atime, mtime): void
Optional: Change the file timestamps of the file.
Parameters
- atime: Date
- mtime: Date
Returns void
Implementation of File.utimesSync

Inherited from PreloadFile.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>
Implementation of File.write

Inherited from PreloadFile.write
- 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]
Implementation of File.writeSync

Inherited from PreloadFile.writeSync
- Defined in src/file.ts:581

Class AsyncKeyValueFile

Todo

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_fs: AsyncKeyValueFileSystem

_path: string

_flag: FileFlag

_stat: Stats

Optional contents: Uint8Array

Returns AsyncKeyValueFile

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

buffer: Uint8Array

offset: number

length: number

`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