Class OverlayFS

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.

Hierarchy

default<UnlockedOverlayFS>
- OverlayFS

Constructors

constructor

new OverlayFS(options): OverlayFS
Parameters
- options: OverlayFS.Options
  
  The options to initialize the OverlayFS with
Returns OverlayFS
Overrides LockedFS<UnlockedOverlayFS>.constructor
- Defined in src/backends/OverlayFS.ts:748

Properties

`Protected` _ready

_ready: Promise<OverlayFS> = ...

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "OverlayFS" = 'OverlayFS'

Accessors

fs

get fs(): T
Returns T
Inherited from LockedFS.fs
- Defined in src/backends/Locked.ts:39

metadata

get metadata(): FileSystemMetadata
Returns FileSystemMetadata
Inherited from LockedFS.metadata
- Defined in src/backends/Locked.ts:32

Methods

`Private` _initialize

_initialize(): Promise<OverlayFS>
Returns Promise<OverlayFS>
- Defined in src/backends/OverlayFS.ts:769

access

access(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.access
- Defined in src/backends/Locked.ts:70

accessSync

accessSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from LockedFS.accessSync
- Defined in src/backends/Locked.ts:76

appendFile

appendFile(fname, data, flag, mode, cred): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.appendFile
- Defined in src/backends/Locked.ts:218

appendFileSync

appendFileSync(fname, data, flag, mode, cred): void
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from LockedFS.appendFileSync
- Defined in src/backends/Locked.ts:224

chmod

chmod(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.chmod
- Defined in src/backends/Locked.ts:231

chmodSync

chmodSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from LockedFS.chmodSync
- Defined in src/backends/Locked.ts:237

chown

chown(p, new_uid, new_gid, cred): Promise<void>
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.chown
- Defined in src/backends/Locked.ts:244

chownSync

chownSync(p, new_uid, new_gid, cred): void
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns void
Inherited from LockedFS.chownSync
- Defined in src/backends/Locked.ts:250

exists

exists(p, cred): Promise<boolean>
Parameters
- p: string
- cred: Cred
Returns Promise<boolean>
Inherited from LockedFS.exists
- Defined in src/backends/Locked.ts:150

existsSync

existsSync(p, cred): boolean
Parameters
- p: string
- cred: Cred
Returns boolean
Inherited from LockedFS.existsSync
- Defined in src/backends/Locked.ts:157

getDeletionLog

getDeletionLog(): string
Returns string
- Defined in src/backends/OverlayFS.ts:757

getOverlayedFileSystems

getOverlayedFileSystems(): OverlayFS.Options
Returns OverlayFS.Options
- Defined in src/backends/OverlayFS.ts:753

link

link(srcpath, dstpath, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.link
- Defined in src/backends/Locked.ts:270

linkSync

linkSync(srcpath, dstpath, cred): void
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns void
Inherited from LockedFS.linkSync
- Defined in src/backends/Locked.ts:276

mkdir

mkdir(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.mkdir
- Defined in src/backends/Locked.ts:123

mkdirSync

mkdirSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from LockedFS.mkdirSync
- Defined in src/backends/Locked.ts:129

open

open(p, flag, mode, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<File>
Inherited from LockedFS.open
- Defined in src/backends/Locked.ts:83

openSync

openSync(p, flag, mode, cred): File
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns File
Inherited from LockedFS.openSync
- Defined in src/backends/Locked.ts:90

readFile

readFile(fname, flag, cred): Promise<Uint8Array>
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Promise<Uint8Array>
Inherited from LockedFS.readFile
- Defined in src/backends/Locked.ts:191

readFileSync

readFileSync(fname, flag, cred): Uint8Array
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Uint8Array
Inherited from LockedFS.readFileSync
- Defined in src/backends/Locked.ts:198

readdir

readdir(p, cred): Promise<string[]>
Parameters
- p: string
- cred: Cred
Returns Promise<string[]>
Inherited from LockedFS.readdir
- Defined in src/backends/Locked.ts:136

readdirSync

readdirSync(p, cred): string[]
Parameters
- p: string
- cred: Cred
Returns string[]
Inherited from LockedFS.readdirSync
- Defined in src/backends/Locked.ts:143

readlink

readlink(p, cred): Promise<string>
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from LockedFS.readlink
- Defined in src/backends/Locked.ts:296

readlinkSync

readlinkSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from LockedFS.readlinkSync
- Defined in src/backends/Locked.ts:303

realpath

realpath(p, cred): Promise<string>
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from LockedFS.realpath
- Defined in src/backends/Locked.ts:164

realpathSync

realpathSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from LockedFS.realpathSync
- Defined in src/backends/Locked.ts:171

rename

rename(oldPath, newPath, cred): Promise<void>
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.rename
- Defined in src/backends/Locked.ts:43

renameSync

renameSync(oldPath, newPath, cred): void
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Inherited from LockedFS.renameSync
- Defined in src/backends/Locked.ts:49

resDeletionLog

resDeletionLog(): string
Returns string
- Defined in src/backends/OverlayFS.ts:761

rmdir

rmdir(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.rmdir
- Defined in src/backends/Locked.ts:110

rmdirSync

rmdirSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from LockedFS.rmdirSync
- Defined in src/backends/Locked.ts:116

stat

stat(p, cred): Promise<Stats>
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Inherited from LockedFS.stat
- Defined in src/backends/Locked.ts:56

statSync

statSync(p, cred): Stats
Parameters
- p: string
- cred: Cred
Returns Stats
Inherited from LockedFS.statSync
- Defined in src/backends/Locked.ts:63

symlink

symlink(srcpath, dstpath, type, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.symlink
- Defined in src/backends/Locked.ts:283

symlinkSync

symlinkSync(srcpath, dstpath, type, cred): void
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns void
Inherited from LockedFS.symlinkSync
- Defined in src/backends/Locked.ts:289

truncate

truncate(p, len, cred): Promise<void>
Parameters
- p: string
- len: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.truncate
- Defined in src/backends/Locked.ts:178

truncateSync

truncateSync(p, len, cred): void
Parameters
- p: string
- len: number
- cred: Cred
Returns void
Inherited from LockedFS.truncateSync
- Defined in src/backends/Locked.ts:184

unlink

unlink(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.unlink
- Defined in src/backends/Locked.ts:97

unlinkSync

unlinkSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from LockedFS.unlinkSync
- Defined in src/backends/Locked.ts:103

unwrap

unwrap(): UnlockedOverlayFS
Returns UnlockedOverlayFS
- Defined in src/backends/OverlayFS.ts:765

utimes

utimes(p, atime, mtime, cred): Promise<void>
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.utimes
- Defined in src/backends/Locked.ts:257

utimesSync

utimesSync(p, atime, mtime, cred): void
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns void
Inherited from LockedFS.utimesSync
- Defined in src/backends/Locked.ts:263

whenReady

whenReady(): Promise<OverlayFS>
Returns Promise<OverlayFS>
Inherited from LockedFS.whenReady
- Defined in src/backends/Locked.ts:28

writeFile

writeFile(fname, data, flag, mode, cred): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from LockedFS.writeFile
- Defined in src/backends/Locked.ts:205

writeFileSync

writeFileSync(fname, data, flag, mode, cred): void
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from LockedFS.writeFileSync
- Defined in src/backends/Locked.ts:211

`Static` isAvailable

isAvailable(): boolean
Returns boolean
- Defined in src/backends/OverlayFS.ts:741

Class OverlayFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: OverlayFS.Options

Returns OverlayFS

Properties

Protected _ready

Static Create

Static Readonly Name

Accessors

fs

Returns T

metadata

Returns FileSystemMetadata

Methods

Private _initialize

Returns Promise<OverlayFS>

access

Parameters

p: string

mode: number

cred: Cred

Returns Promise<void>

accessSync

Parameters

p: string

mode: number

cred: Cred

Returns void

appendFile

Parameters

fname: string

data: Uint8Array

flag: FileFlag

mode: number

cred: Cred

Returns Promise<void>

appendFileSync

Parameters

fname: string

data: Uint8Array

flag: FileFlag

mode: number

cred: Cred

Returns void

chmod

Parameters

p: string

mode: number

cred: Cred

Returns Promise<void>

chmodSync

Parameters

p: string

mode: number

cred: Cred

Returns void

chown

Parameters

p: string

new_uid: number

new_gid: number

cred: Cred

Returns Promise<void>

chownSync

Parameters

p: string

new_uid: number

new_gid: number

cred: Cred

Returns void

exists

Parameters

`Protected` _ready

`Static` Create

`Static` `Readonly` Name

`Private` _initialize