MemoryVolume

Nodepod API

---

Nodepod API / src / MemoryVolume

Class: MemoryVolume

Defined in: src/memory-volume.ts:246

Constructors

Constructor

new MemoryVolume(handler?, lazyResidentMaxBytes?): MemoryVolume

Defined in: src/memory-volume.ts:421

Parameters

handler?

MemoryHandler | null

lazyResidentMaxBytes?

number = ...

Returns

MemoryVolume

Methods

access()

access(p, modeOrCb?, cb?): void

Defined in: src/memory-volume.ts:1977

Parameters

p

string

modeOrCb?

number | ((err) => void)

cb?

(err) => void

Returns

void

---

accessSync()

accessSync(p, mode?): void

Defined in: src/memory-volume.ts:1643

Parameters

p

string

mode?

number = 0

Returns

void

---

appendFileSync()

appendFileSync(p, data): void

Defined in: src/memory-volume.ts:1878

Parameters

p

string

data

unknown

Returns

void

---

chmodSync()

chmodSync(_p, _mode): void

Defined in: src/memory-volume.ts:1759

Parameters

_p

string

_mode

number

Returns

void

---

chownSync()

chownSync(p, uid, gid): void

Defined in: src/memory-volume.ts:1791

Parameters

p

string

uid

number

gid

number

Returns

void

---

copyFileSync()

copyFileSync(src, dest, mode?): void

Defined in: src/memory-volume.ts:1654

Parameters

src

string

dest

string

mode?

number = 0

Returns

void

---

createReadStream()

createReadStream(p): object

Defined in: src/memory-volume.ts:2092

Parameters

p

string

Returns

object

on

on: (event, cb) => void

Parameters

event

string

cb

(…args) => void

Returns

void

pipe

pipe: (dest) => unknown

Parameters

dest

unknown

Returns

unknown

---

createWriteStream()

createWriteStream(p): object

Defined in: src/memory-volume.ts:2121

Parameters

p

string

Returns

object

end

end: (data?) => void

Parameters

data?

string | Uint8Array<ArrayBufferLike>

Returns

void

on

on: (event, cb) => void

Parameters

event

string

cb

(…args) => void

Returns

void

write

write: (data) => boolean

Parameters

data

string | Uint8Array<ArrayBufferLike>

Returns

boolean

---

dispose()

dispose(): void

Defined in: src/memory-volume.ts:515

Clean up all owned data and listeners. A disposed volume is empty.

Returns

void

---

existsSync()

existsSync(p): boolean

Defined in: src/memory-volume.ts:1220

Parameters

p

string

Returns

boolean

---

getStats()

getStats(): object

Defined in: src/memory-volume.ts:493

Returns

object

dirCount

dirCount: number

fileCount

fileCount: number

lazyResidentBytes

lazyResidentBytes: number

totalBytes

totalBytes: number

watcherCount

watcherCount: number

---

lchmodSync()

lchmodSync(p, mode): void

Defined in: src/memory-volume.ts:1775

Parameters

p

string

mode

number

Returns

void

---

lchownSync()

lchownSync(p, uid, gid): void

Defined in: src/memory-volume.ts:1808

Parameters

p

string

uid

number

gid

number

Returns

void

---

linkSync()

linkSync(existingPath, newPath): void

Defined in: src/memory-volume.ts:1734

Parameters

existingPath

string

newPath

string

Returns

void

---

lstat()

lstat(p, cb?): void

Defined in: src/memory-volume.ts:1945

Parameters

p

string

cb?

(err, stats?) => void

Returns

void

---

lstatSync()

lstatSync(p): FileStat

Defined in: src/memory-volume.ts:1286

Parameters

p

string

Returns

FileStat

---

lutimesSync()

lutimesSync(p, atime, mtime): void

Defined in: src/memory-volume.ts:1861

Parameters

p

string

atime

number | Date

mtime

number | Date

Returns

void

---

markLazyInvalidated()

markLazyInvalidated(p): void

Defined in: src/memory-volume.ts:1087

Parameters

p

string

Returns

void

---

mkdirSync()

mkdirSync(p, options?): string | undefined

Defined in: src/memory-volume.ts:1408

Parameters

p

string

options?

mode?

number

recursive?

boolean

Returns

string | undefined

---

mountBinarySnapshot()

mountBinarySnapshot(snapshot, notifyBulk?): number

Defined in: src/memory-volume.ts:623

Parameters

snapshot

data

ArrayBuffer

manifest

BinaryVolumeEntry[]

notifyBulk?

boolean = true

Returns

number

---

off()

Call Signature

off(event, handler): this

Defined in: src/memory-volume.ts:443

Parameters

event

"change"

handler

FileChangeHandler

Returns

this

Call Signature

off(event, handler): this

Defined in: src/memory-volume.ts:444

Parameters

event

"delete"

handler

FileDeleteHandler

Returns

this

---

on()

Call Signature

on(event, handler): this

Defined in: src/memory-volume.ts:433

Parameters

event

"change"

handler

FileChangeHandler

Returns

this

Call Signature

on(event, handler): this

Defined in: src/memory-volume.ts:434

Parameters

event

"delete"

handler

FileDeleteHandler

Returns

this

---

onGlobalChange()

onGlobalChange(cb): () => void

Defined in: src/memory-volume.ts:2079

Parameters

cb

(path, event) => void

Returns

() => void

---

openFileHandleSync()

openFileHandleSync(p): VolumeFileHandle

Defined in: src/memory-volume.ts:1361

Parameters

p

string

Returns

VolumeFileHandle

---

readdir()

readdir(p, optionsOrCb?, cb?): void

Defined in: src/memory-volume.ts:1954

Parameters

p

string

optionsOrCb?

{ withFileTypes?: boolean; } | ((err, files?) => void)

cb?

(err, files?) => void

Returns

void

---

readdirSync()

readdirSync(p): string[]

Defined in: src/memory-volume.ts:1448

Parameters

p

string

Returns

string[]

---

readFile()

readFile(p, optionsOrCb?, cb?): void

Defined in: src/memory-volume.ts:1919

Parameters

p

string

optionsOrCb?

{ encoding?: string; } | ((err, data?) => void)

cb?

(err, data?) => void

Returns

void

---

readFileSync()

Call Signature

readFileSync(p): Uint8Array

Defined in: src/memory-volume.ts:1333

Parameters

p

string

Returns

Uint8Array

Call Signature

readFileSync(p, encoding): string

Defined in: src/memory-volume.ts:1334

Parameters

p

string

encoding

"utf8" | "utf-8"

Returns

string

---

readlinkSync()

readlinkSync(p): string

Defined in: src/memory-volume.ts:1719

Parameters

p

string

Returns

string

---

realpath()

realpath(p, cb?): void

Defined in: src/memory-volume.ts:1968

Parameters

p

string

cb?

(err, resolved?) => void

Returns

void

---

realpathSync()

realpathSync(p): string

Defined in: src/memory-volume.ts:1663

Parameters

p

string

Returns

string

---

rebuildIndexes()

rebuildIndexes(): void

Defined in: src/memory-volume.ts:456

Rebuild internal inode indexes after an external tree replacement.

Returns

void

---

removeTreeSync()

removeTreeSync(p): void

Defined in: src/memory-volume.ts:1509

Parameters

p

string

Returns

void

---

renameSync()

renameSync(from, to): void

Defined in: src/memory-volume.ts:1553

Parameters

from

string

to

string

Returns

void

---

rmdirSync()

rmdirSync(p): void

Defined in: src/memory-volume.ts:1482

Parameters

p

string

Returns

void

---

setBulkMountHandler()

setBulkMountHandler(handler): void

Defined in: src/memory-volume.ts:451

Parameters

handler

((snapshot) => void) | null

Returns

void

---

setMissHandler()

setMissHandler(handler, lazyDirNames?): void

Defined in: src/memory-volume.ts:992

Parameters

handler

VolumeMissHandler | null

lazyDirNames?

string[] = []

Returns

void

---

stat()

stat(p, cb?): void

Defined in: src/memory-volume.ts:1936

Parameters

p

string

cb?

(err, stats?) => void

Returns

void

---

statSync()

statSync(p): FileStat

Defined in: src/memory-volume.ts:1229

Parameters

p

string

Returns

FileStat

---

symlinkSync()

symlinkSync(target, linkPath, type?): void

Defined in: src/memory-volume.ts:1693

Parameters

target

string

linkPath

string

type?

string

Returns

void

---

toSnapshot()

toSnapshot(excludePrefixes?, excludeDirNames?): VolumeSnapshot

Defined in: src/memory-volume.ts:544

Parameters

excludePrefixes?

string[]

excludeDirNames?

Set<string>

Returns

VolumeSnapshot

---

truncateSync()

truncateSync(p, len?): void

Defined in: src/memory-volume.ts:1893

Parameters

p

string

len?

number = 0

Returns

void

---

unlinkSync()

unlinkSync(p): void

Defined in: src/memory-volume.ts:1460

Parameters

p

string

Returns

void

---

utimesSync()

utimesSync(p, atime, mtime): void

Defined in: src/memory-volume.ts:1844

Parameters

p

string

atime

number | Date

mtime

number | Date

Returns

void

---

watch()

watch(target, optionsOrCb?, cb?): FileWatchHandle

Defined in: src/memory-volume.ts:1990

Parameters

target

string

optionsOrCb?

WatchCallback | { encoding?: string; persistent?: boolean; recursive?: boolean; }

cb?

WatchCallback

Returns

FileWatchHandle

---

writeCacheSync()

writeCacheSync(p, data): void

Defined in: src/memory-volume.ts:1403

Parameters

p

string

data

unknown

Returns

void

---

writeFileSync()

writeFileSync(p, data): void

Defined in: src/memory-volume.ts:1397

Parameters

p

string

data

unknown

Returns

void

---

fromBinarySnapshot()

static fromBinarySnapshot(snapshot): MemoryVolume

Defined in: src/memory-volume.ts:616

Parameters

snapshot

data

ArrayBuffer

manifest

BinaryVolumeEntry[]

Returns

MemoryVolume

---

fromSnapshot()

static fromSnapshot(snapshot): MemoryVolume

Defined in: src/memory-volume.ts:707

Parameters

snapshot

VolumeSnapshot

Returns

MemoryVolume