Class UnmutexedOverlayFS`Internal`

OverlayFS makes a read-only filesystem writable by storing writes on a second, writable file system. Deletes are persisted via metadata stored on the writable file system.

This class contains no locking whatsoever. It is mutexed to prevent races.

Hierarchy (view full)

FileSystem
- UnmutexedOverlayFS

Constructors

constructor

new UnmutexedOverlayFS(__namedParameters): UnmutexedOverlayFS
Parameters
- __namedParameters: OverlayOptions
Returns UnmutexedOverlayFS
Overrides FileSystem.constructor
- Defined in src/backends/overlay.ts:60

Properties

`Private` _deleteLog

_deleteLog: string = ''

`Private` `Optional` _deleteLogError

_deleteLogError?: ErrnoError

`Private` _deleteLogUpdateNeeded

_deleteLogUpdateNeeded: boolean = false

`Private` _deleteLogUpdatePending

_deleteLogUpdatePending: boolean = false

`Private` _deletedFiles

_deletedFiles: Set<string> = ...

`Optional` `Protected` `Internal` _disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

`Private` _isInitialized

_isInitialized: boolean = false

`Private` _ready

_ready: Promise<void>

`Readonly` readable

readable: FileSystem

`Readonly` writable

writable: FileSystem

Methods

_initialize

_initialize(): Promise<void>
Internal
Called once to load up metadata stored on the writable file system.

Returns Promise<void>
- Defined in src/backends/overlay.ts:94

`Private` _reparseDeletionLog

_reparseDeletionLog(): void
Returns void
- Defined in src/backends/overlay.ts:397

`Private` checkInitialized

checkInitialized(): void
Returns void
- Defined in src/backends/overlay.ts:410

`Private` checkPath

checkPath(path): void
Parameters
- path: string
Returns void
- Defined in src/backends/overlay.ts:424

`Private` copyToWritable

copyToWritable(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/backends/overlay.ts:509

`Private` copyToWritableSync

copyToWritableSync(path): void
Copy from readable to writable storage. PRECONDITION: File does not exist on writable storage.
Parameters
- path: string
Returns void
- Defined in src/backends/overlay.ts:493

createFile

createFile(path, flag, mode): Promise<File>
Create the file at path with the given mode. Then, open it with the given flag.
Parameters
- path: string
- flag: string
- mode: number
Returns Promise<File>
Overrides FileSystem.createFile
- Defined in src/backends/overlay.ts:205

createFileSync

createFileSync(path, flag, mode): File
Create the file at path with the given mode. Then, open it with the given flag.
Parameters
- path: string
- flag: string
- mode: number
Returns File
Overrides FileSystem.createFileSync
- Defined in src/backends/overlay.ts:211

`Private` createParentDirectories

createParentDirectories(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/backends/overlay.ts:448

`Private` createParentDirectoriesSync

createParentDirectoriesSync(path): void
With the given path, create the needed parent directories on the writable storage should they not exist. Use modes from the read-only storage.
Parameters
- path: string
Returns void
- Defined in src/backends/overlay.ts:434

`Private` deletePath

deletePath(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/backends/overlay.ts:371

exists

exists(path): Promise<boolean>
Test whether or not the given path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from FileSystem.exists
- Defined in src/filesystem.ts:185

existsSync

existsSync(path): boolean
Test whether or not the given path exists.
Parameters
- path: string
Returns boolean
Inherited from FileSystem.existsSync
- Defined in src/filesystem.ts:197

getDeletionLog

getDeletionLog(): string
Returns string
- Defined in src/backends/overlay.ts:114

link

link(srcpath, dstpath): Promise<void>
Asynchronous link.
Parameters
- srcpath: string
- dstpath: string
Returns Promise<void>
Overrides FileSystem.link
- Defined in src/backends/overlay.ts:217

linkSync

linkSync(srcpath, dstpath): void
Synchronous link.
Parameters
- srcpath: string
- dstpath: string
Returns void
Overrides FileSystem.linkSync
- Defined in src/backends/overlay.ts:222

metadata

metadata(): FileSystemMetadata
Get metadata about the current file system

Returns FileSystemMetadata
Overrides FileSystem.metadata
- Defined in src/backends/overlay.ts:70

mkdir

mkdir(path, mode): Promise<void>
Asynchronous mkdir.
Parameters
- path: string
- mode: number
  Mode to make the directory using.
Returns Promise<void>
Overrides FileSystem.mkdir
- Defined in src/backends/overlay.ts:297

mkdirSync

mkdirSync(path, mode): void
Synchronous mkdir.
Parameters
- path: string
- mode: number
  Mode to make the directory using.
Returns void
Overrides FileSystem.mkdirSync
- Defined in src/backends/overlay.ts:307

openFile

openFile(path, flag): Promise<File>
Opens the file at path with the given flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns Promise<File>
Overrides FileSystem.openFile
- Defined in src/backends/overlay.ts:182

openFileSync

openFileSync(path, flag): File
Opens the file at path with the given flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns File
A File object corresponding to the opened file.
Overrides FileSystem.openFileSync
- Defined in src/backends/overlay.ts:193

`Private` operateOnWritable

operateOnWritable(path): void
Helper function:
- Ensures p is on writable before proceeding. Throws an error if it doesn't exist.
- Calls f to perform operation on writable.
Parameters
- path: string
Returns void
- Defined in src/backends/overlay.ts:468

`Private` operateOnWritableAsync

operateOnWritableAsync(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/backends/overlay.ts:479

readdir

readdir(path): Promise<string[]>
Asynchronous readdir. Reads the contents of a directory.
Parameters
- path: string
Returns Promise<string[]>
Overrides FileSystem.readdir
- Defined in src/backends/overlay.ts:317

readdirSync

readdirSync(path): string[]
Synchronous readdir. Reads the contents of a directory.
Parameters
- path: string
Returns string[]
Overrides FileSystem.readdirSync
- Defined in src/backends/overlay.ts:344

ready

ready(): Promise<void>
Returns Promise<void>
Overrides FileSystem.ready
- Defined in src/backends/overlay.ts:39

rename

rename(oldPath, newPath): Promise<void>
Asynchronous rename.
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Overrides FileSystem.rename
- Defined in src/backends/overlay.ts:124

renameSync

renameSync(oldPath, newPath): void
Synchronous rename.
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides FileSystem.renameSync
- Defined in src/backends/overlay.ts:138

restoreDeletionLog

restoreDeletionLog(log): Promise<void>
Parameters
- log: string
Returns Promise<void>
- Defined in src/backends/overlay.ts:118

rmdir

rmdir(path): Promise<void>
Asynchronous rmdir.
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.rmdir
- Defined in src/backends/overlay.ts:261

rmdirSync

rmdirSync(path): void
Synchronous rmdir.
Parameters
- path: string
Returns void
Overrides FileSystem.rmdirSync
- Defined in src/backends/overlay.ts:279

stat

stat(path): Promise<Stats>
Asynchronous stat.
Parameters
- path: string
Returns Promise<Stats>
Overrides FileSystem.stat
- Defined in src/backends/overlay.ts:152

statSync

statSync(path): Stats
Synchronous stat.
Parameters
- path: string
Returns Stats
Overrides FileSystem.statSync
- Defined in src/backends/overlay.ts:167

sync

sync(path, data, stats): Promise<void>
Synchronize the data and stats for path asynchronously
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns Promise<void>
Overrides FileSystem.sync
- Defined in src/backends/overlay.ts:77

syncSync

syncSync(path, data, stats): void
Synchronize the data and stats for path synchronously
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns void
Overrides FileSystem.syncSync
- Defined in src/backends/overlay.ts:85

unlink

unlink(path): Promise<void>
Asynchronous unlink.
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.unlink
- Defined in src/backends/overlay.ts:227

unlinkSync

unlinkSync(path): void
Synchronous unlink.
Parameters
- path: string
Returns void
Overrides FileSystem.unlinkSync
- Defined in src/backends/overlay.ts:244

`Private` updateLog

updateLog(addition): Promise<void>
Parameters
- addition: string
Returns Promise<void>
- Defined in src/backends/overlay.ts:376

Class UnmutexedOverlayFSInternal

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UnmutexedOverlayFS

Properties

Private _deleteLog

Private Optional _deleteLogError

Private _deleteLogUpdateNeeded

Private _deleteLogUpdatePending

Private _deletedFiles

Optional Protected Internal _disableSync

Private _isInitialized

Private _ready

Readonly readable

Readonly writable

Methods

_initialize

Returns Promise<void>

Private _reparseDeletionLog

Returns void

Private checkInitialized

Returns void

Private checkPath

Parameters

Returns void

Private copyToWritable

Parameters

Returns Promise<void>

Private copyToWritableSync

Parameters

Returns void

createFile

Parameters

Returns Promise<File>

createFileSync

Parameters

Returns File

Private createParentDirectories

Parameters

Returns Promise<void>

Private createParentDirectoriesSync

Parameters

Returns void

Private deletePath

Parameters

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

getDeletionLog

Returns string

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

mkdir

Parameters

Returns Promise<void>

mkdirSync

Parameters

Returns void

openFile

Parameters

Returns Promise<File>

openFileSync

Parameters

Returns File

Class UnmutexedOverlayFS`Internal`

`Private` _deleteLog

`Private` `Optional` _deleteLogError

`Private` _deleteLogUpdateNeeded

`Private` _deleteLogUpdatePending

`Private` _deletedFiles

`Optional` `Protected` `Internal` _disableSync

`Private` _isInitialized

`Private` _ready

`Readonly` readable

`Readonly` writable

`Private` _reparseDeletionLog

`Private` checkInitialized

`Private` checkPath

`Private` copyToWritable

`Private` copyToWritableSync

`Private` createParentDirectories

`Private` createParentDirectoriesSync

`Private` deletePath

`Private` operateOnWritable

`Private` operateOnWritableAsync

`Private` updateLog