Class EncryptedFS

Hierarchy

CreateDestroyStartStop
- EncryptedFS

Index

Constructors

Properties

[initLock] _cwd blockSize chrootParent? chroots crypto? db dbOwned fdMgr gid iNodeMgr iNodeMgrOwned logger rootIno uid umask

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status] constants cwd promises

Constructors

constructor

new EncryptedFS(__namedParameters): EncryptedFS
Parameters
- __namedParameters: {
      blockSize: number;
      chrootParent?: EncryptedFS;
      chroots?: Set<EncryptedFS>;
      crypto?: {
          key: Buffer;
          ops: Crypto;
      };
      db: DB;
      dbOwned: boolean;
      fdMgr: FileDescriptorManager;
      iNodeMgr: INodeManager;
      iNodeMgrOwned: boolean;
      logger: Logger;
      rootIno: INodeIndex;
      umask: number;
  }
  - blockSize: number
  - Optional chrootParent?: EncryptedFS
  - Optional chroots?: Set<EncryptedFS>
  - Optional crypto?: {
    key: Buffer;
    ops: Crypto;
    }
    - key: Buffer
    - ops: Crypto
  - db: DB
  - dbOwned: boolean
  - fdMgr: FileDescriptorManager
  - iNodeMgr: INodeManager
  - iNodeMgrOwned: boolean
  - logger: Logger
  - rootIno: INodeIndex
  - umask: number
Returns EncryptedFS
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/EncryptedFS.ts:202

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` _cwd

_cwd: CurrentDirectory

`Readonly` blockSize

blockSize: number

`Protected` `Optional` chrootParent

chrootParent?: EncryptedFS

`Protected` chroots

chroots: Set<EncryptedFS>

`Protected` `Optional` crypto

crypto?: {
key: Buffer;
ops: Crypto;
}

Type declaration

key: Buffer
ops: Crypto

`Protected` db

db: DB

`Protected` dbOwned

dbOwned: boolean

`Protected` fdMgr

fdMgr: FileDescriptorManager

gid

gid: number = permissions.DEFAULT_ROOT_GID

`Protected` iNodeMgr

iNodeMgr: INodeManager

`Protected` iNodeMgrOwned

iNodeMgrOwned: boolean

`Protected` logger

logger: Logger

`Protected` rootIno

rootIno: INodeIndex

uid

uid: number = permissions.DEFAULT_ROOT_UID

umask

umask: number

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from createDestroyStartStop.CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

constants

get constants(): constants
Returns constants
- Defined in src/EncryptedFS.ts:251

cwd

get cwd(): string
Returns string
- Defined in src/EncryptedFS.ts:247

promises

get promises(): this
Returns this
- Defined in src/EncryptedFS.ts:255

Methods

`Protected` _open

_open(path, flags, mode?, tran?): Promise<[FileDescriptor, FdIndex]>
This call must handle concurrent races to create the file inode
Parameters
- path: Path
- flags: string | number
- mode: number = permissions.DEFAULT_FILE_PERM
- Optional tran: DBTransaction
Returns Promise<[FileDescriptor, FdIndex]>
- Defined in src/EncryptedFS.ts:1935

access

access(path, mode?): Promise<void>
Parameters
- path: Path
- Optional mode: number
Returns Promise<void>
- Defined in src/EncryptedFS.ts:424
access(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:425
access(path, mode, callback): Promise<void>
Parameters
- path: Path
- mode: number
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:426

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

appendFile

appendFile(file, data, options?): Promise<void>
Parameters
- file: FdIndex | Path
- data: Data
- Optional options: Options
Returns Promise<void>
- Defined in src/EncryptedFS.ts:474
appendFile(file, data, callback): Promise<void>
Parameters
- file: FdIndex | Path
- data: Data
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:479
appendFile(file, data, options, callback): Promise<void>
Parameters
- file: FdIndex | Path
- data: Data
- options: Options
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:484

chdir

chdir(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/EncryptedFS.ts:382
chdir(path, callback): Promise<void>
Parameters
- path: string
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:383

`Protected` checkPermissions

checkPermissions(access, stat): boolean
Checks the permissions fixng the current uid and gid. If the user is root, they can access anything.
Parameters
- access: number
- stat: Stat
Returns boolean
- Defined in src/EncryptedFS.ts:3697

chmod

chmod(path, mode, callback?): Promise<void>
Parameters
- path: Path
- mode: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:567

chown

chown(path, uid, gid, callback?): Promise<void>
Parameters
- path: Path
- uid: number
- gid: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:613

chownr

chownr(path, uid, gid, callback?): Promise<void>
Parameters
- path: Path
- uid: number
- gid: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:665

chroot

chroot(path): Promise<EncryptedFS>
Parameters
- path: string
Returns Promise<EncryptedFS>
- Defined in src/EncryptedFS.ts:321
chroot(path, callback): Promise<void>
Parameters
- path: string
- callback: Callback<[EncryptedFS]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:322

close

close(fdIndex, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:692

copyFile

copyFile(srcPath, dstPath, flags?): Promise<void>
Parameters
- srcPath: Path
- dstPath: Path
- Optional flags: number
Returns Promise<void>
- Defined in src/EncryptedFS.ts:705
copyFile(srcPath, dstPath, callback): Promise<void>
Parameters
- srcPath: Path
- dstPath: Path
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:710
copyFile(srcPath, dstPath, flags, callback): Promise<void>
Parameters
- srcPath: Path
- dstPath: Path
- flags: number
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:715

createReadStream

createReadStream(path, options?): ReadStream
Parameters
- path: Path
- Optional options: OptionsStream
Returns ReadStream
- Defined in src/EncryptedFS.ts:819

createWriteStream

createWriteStream(path, options?): WriteStream
Parameters
- path: Path
- Optional options: OptionsStream
Returns WriteStream
- Defined in src/EncryptedFS.ts:839

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.destroy
- Defined in src/EncryptedFS.ts:298

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

exists

exists(path, callback?): Promise<boolean | void>
Parameters
- path: Path
- Optional callback: Callback<[boolean]>
Returns Promise<boolean | void>
- Defined in src/EncryptedFS.ts:858

fallocate

fallocate(fdIndex, offset, len, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- offset: number
- len: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:873

fchmod

fchmod(fdIndex, mode, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- mode: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:952

fchown

fchown(fdIndex, uid, gid, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- uid: number
- gid: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:994

fdatasync

fdatasync(fdIndex, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1041

fstat

fstat(fdIndex): Promise<Stat>
Parameters
- fdIndex: FdIndex
Returns Promise<Stat>
- Defined in src/EncryptedFS.ts:1053
fstat(fdIndex, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- callback: Callback<[Stat]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1054

fsync

fsync(fdIndex, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1088

ftruncate

ftruncate(fdIndex, len?): Promise<void>
Parameters
- fdIndex: FdIndex
- Optional len: number
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1100
ftruncate(fdIndex, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1101
ftruncate(fdIndex, len, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- len: number
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1102

futimes

futimes(fdIndex, atime, mtime, callback?): Promise<void>
Parameters
- fdIndex: FdIndex
- atime: string | number | Date
- mtime: string | number | Date
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1207

`Protected` getBuffer

getBuffer(data, encoding?): Buffer
Processes data types and collapses it to a Buffer. The data types can be Buffer or Uint8Array or string.
Parameters
- data: Data
- encoding: undefined | BufferEncoding = undefined
Returns Buffer
- Defined in src/EncryptedFS.ts:3761

`Protected` getOptions

getOptions(defaultOptions, options?): Options
Takes a default set of options, and merges them shallowly into the user provided options. Object spread syntax will ignore an undefined or null options object.
Parameters
- defaultOptions: {
      encoding?: BufferEncoding;
      flag?: string;
      mode?: number;
      recursive?: boolean;
  }
  - Optional encoding?: BufferEncoding
  - Optional flag?: string
  - Optional mode?: number
  - Optional recursive?: boolean
- Optional options: BufferEncoding | Options
Returns Options
- Defined in src/EncryptedFS.ts:3741

`Protected` getPath

getPath(path): string
Processes path types and collapses it to a string. The path types can be string or Buffer or URL.
Parameters
- path: Path
Returns string
- Defined in src/EncryptedFS.ts:3709

`Protected` getPathFromURL

getPathFromURL(url): string
Acquires the file path from an URL object.
Parameters
- url: URL
Returns string
- Defined in src/EncryptedFS.ts:3725

lchmod

lchmod(path, mode, callback?): Promise<void>
Parameters
- path: Path
- mode: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1253

lchown

lchown(path, uid, gid, callback?): Promise<void>
Parameters
- path: Path
- uid: number
- gid: number
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1299

link

link(existingPath, newPath, callback?): Promise<void>
Parameters
- existingPath: Path
- newPath: Path
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1351

lseek

lseek(fdIndex, position, seekFlags?): Promise<number>
Parameters
- fdIndex: FdIndex
- position: number
- Optional seekFlags: number
Returns Promise<number>
- Defined in src/EncryptedFS.ts:1444
lseek(fdIndex, position, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- position: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1449
lseek(fdIndex, position, seekFlags, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- position: number
- seekFlags: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1454

lstat

lstat(path): Promise<Stat>
Parameters
- path: Path
Returns Promise<Stat>
- Defined in src/EncryptedFS.ts:1507
lstat(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback<[Stat]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1508

mkdir

mkdir(path, options?): Promise<void>
Makes a directory

This call must handle concurrent races to create the directory inode
Parameters
- path: Path
- Optional options: number | Options
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1547
mkdir(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1548
mkdir(path, options, callback): Promise<void>
Parameters
- path: Path
- options: number | Options
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1549

mkdtemp

mkdtemp(pathSPrefix, options?): Promise<string | Buffer>
Parameters
- pathSPrefix: string
- Optional options: Options
Returns Promise<string | Buffer>
- Defined in src/EncryptedFS.ts:1725
mkdtemp(pathSPrefix, callback): Promise<void>
Parameters
- pathSPrefix: string
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1729
mkdtemp(pathSPrefix, options, callback): Promise<void>
Parameters
- pathSPrefix: string
- options: Options
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1733

mknod

mknod(path, type, major, minor, mode?): Promise<void>
Makes an inode

This call must handle concurrent races to create the inode
Parameters
- path: Path
- type: number
- major: number
- minor: number
- Optional mode: number
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1789
mknod(path, type, major, minor, callback): Promise<void>
Parameters
- path: Path
- type: number
- major: number
- minor: number
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1796
mknod(path, type, major, minor, mode, callback): Promise<void>
Parameters
- path: Path
- type: number
- major: number
- minor: number
- mode: number
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1803

`Protected` navigate

navigate(pathS, resolveLastLink?, activeSymlinks?, origPathS?): Promise<Navigated>
Navigates the filesystem tree from root. You can interpret the results like: target == null => Non-existent segment name === '' => Target is at root name === '.' => dir is the same as target name === '..' => dir is a child directory
Parameters
- pathS: string
- resolveLastLink: boolean = true
- activeSymlinks: Set<INodeIndex> = ...
- origPathS: string = pathS
Returns Promise<Navigated>
- Defined in src/EncryptedFS.ts:3444

`Protected` navigateFrom

navigateFrom(curdir, pathS, resolveLastLink?, activeSymlinks?, pathStack?, origPathS?, tran?): Promise<Navigated>
Navigates the filesystem tree from a given directory. You should not use this directly unless you first call _navigate and pass the remaining path to _navigateFrom. Note that the pathStack is always the full path to the target.

Each navigateFrom call usually has its own transaction context It does not preserve transaction context on recursive calls to this.navigate or this.navigateFrom. This is because navigation on from a particular inode is a self-contained operation.

Callers must pass an existing transaction context if they are navigating from an inode that was just created within that transaction context, this is necessary because otherwise there will be a deadlock when this.navigateFrom starts their own transaction context on that inode
Parameters
- curdir: INodeIndex
- pathS: string
- resolveLastLink: boolean = true
- activeSymlinks: Set<INodeIndex> = ...
- pathStack: string[] = []
- origPathS: string = pathS
- Optional tran: DBTransaction
Returns Promise<Navigated>
- Defined in src/EncryptedFS.ts:3511

open

open(path, flags, mode?): Promise<FdIndex>
Parameters
- path: Path
- flags: string | number
- Optional mode: number
Returns Promise<FdIndex>
- Defined in src/EncryptedFS.ts:1897
open(path, flags, callback): Promise<void>
Parameters
- path: Path
- flags: string | number
- callback: Callback<[FdIndex]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1902
open(path, flags, mode, callback): Promise<void>
Parameters
- path: Path
- flags: string | number
- mode: number
- callback: Callback<[FdIndex]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:1907

`Protected` parsePath

parsePath(pathS): ParsedPath
Parses and extracts the first path segment.
Parameters
- pathS: string
Returns ParsedPath
- Defined in src/EncryptedFS.ts:3678

read

read(fdIndex, buffer, offset?, length?, position?): Promise<number>
Parameters
- fdIndex: FdIndex
- buffer: Data
- Optional offset: number
- Optional length: number
- Optional position: number
Returns Promise<number>
- Defined in src/EncryptedFS.ts:2234
read(fdIndex, buffer, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- buffer: Data
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2241
read(fdIndex, buffer, offset, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- buffer: Data
- offset: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2246
read(fdIndex, buffer, offset, length, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- buffer: Data
- offset: number
- length: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2252
read(fdIndex, buffer, offset, length, position, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- buffer: Data
- offset: number
- length: number
- position: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2259

readFile

readFile(file, options?): Promise<string | Buffer>
Parameters
- file: File
- Optional options: Options
Returns Promise<string | Buffer>
- Defined in src/EncryptedFS.ts:2429
readFile(file, callback): Promise<void>
Parameters
- file: File
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2433
readFile(file, options, callback): Promise<void>
Parameters
- file: File
- options: Options
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2437

readdir

readdir(path, options?): Promise<(string | Buffer)[]>
Parameters
- path: Path
- Optional options: Options
Returns Promise<(string | Buffer)[]>
- Defined in src/EncryptedFS.ts:2348
readdir(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback<[(string | Buffer)[]]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2352
readdir(path, options, callback): Promise<void>
Parameters
- path: Path
- options: Options
- callback: Callback<[(string | Buffer)[]]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2356

readlink

readlink(path, options?): Promise<string | Buffer>
Parameters
- path: Path
- Optional options: Options
Returns Promise<string | Buffer>
- Defined in src/EncryptedFS.ts:2481
readlink(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2485
readlink(path, options, callback): Promise<void>
Parameters
- path: Path
- options: Options
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2489

realpath

realpath(path, options?): Promise<string | Buffer>
Parameters
- path: Path
- Optional options: Options
Returns Promise<string | Buffer>
- Defined in src/EncryptedFS.ts:2548
realpath(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2552
realpath(path, options, callback): Promise<void>
Parameters
- path: Path
- options: Options
- callback: Callback<[string | Buffer]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2556

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

rename

rename(oldPath, newPath, callback?): Promise<void>
Parameters
- oldPath: Path
- newPath: Path
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2595

rmdir

rmdir(path, options?): Promise<void>
Parameters
- path: Path
- Optional options: Options
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2836
rmdir(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2837
rmdir(path, options, callback): Promise<void>
Parameters
- path: Path
- options: Options
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2838

setWorkerManager

setWorkerManager(workerManager): void
Parameters
- workerManager: DBWorkerManagerInterface
Returns void
- Defined in src/EncryptedFS.ts:313

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.start
- Defined in src/EncryptedFS.ts:259

stat

stat(path): Promise<Stat>
Parameters
- path: Path
Returns Promise<Stat>
- Defined in src/EncryptedFS.ts:2981
stat(path, callback): Promise<void>
Parameters
- path: Path
- callback: Callback<[Stat]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:2982

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/EncryptedFS.ts:279

symlink

symlink(dstPath, srcPath, type?): Promise<void>
Makes a symlink

This call must handle concurrent races to create the symlink inode
Parameters
- dstPath: Path
- srcPath: Path
- Optional type: string
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3021
symlink(dstPath, srcPath, callback): Promise<void>
Parameters
- dstPath: Path
- srcPath: Path
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3026
symlink(dstPath, srcPath, type, callback): Promise<void>
Parameters
- dstPath: Path
- srcPath: Path
- type: string
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3031

truncate

truncate(file, len?): Promise<void>
Parameters
- file: File
- Optional len: number
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3116
truncate(file, callback): Promise<void>
Parameters
- file: File
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3117
truncate(file, len, callback): Promise<void>
Parameters
- file: File
- len: number
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3118

unlink

unlink(path, callback?): Promise<void>
Parameters
- path: Path
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3153

unsetWorkerManager

unsetWorkerManager(): void
Returns void
- Defined in src/EncryptedFS.ts:317

utimes

utimes(path, atime, mtime, callback?): Promise<void>
Parameters
- path: Path
- atime: string | number | Date
- mtime: string | number | Date
- Optional callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3207

write

write(fdIndex, data, offsetOrPos?, lengthOrEncoding?, position?): Promise<number>
Parameters
- fdIndex: FdIndex
- data: Data
- Optional offsetOrPos: number
- Optional lengthOrEncoding: string | number
- Optional position: number
Returns Promise<number>
- Defined in src/EncryptedFS.ts:3256
write(fdIndex, data, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- data: Data
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3263
write(fdIndex, data, offsetOrPos, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- data: Data
- offsetOrPos: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3268
write(fdIndex, data, offsetOrPos, lengthOrEncoding, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- data: Data
- offsetOrPos: number
- lengthOrEncoding: string | number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3274
write(fdIndex, data, offsetOrPos, lengthOrEncoding, position, callback): Promise<void>
Parameters
- fdIndex: FdIndex
- data: Data
- offsetOrPos: number
- lengthOrEncoding: string | number
- position: number
- callback: Callback<[number]>
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3281

writeFile

writeFile(file, data?, options?): Promise<void>
Parameters
- file: File
- Optional data: Data
- Optional options: Options
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3378
writeFile(file, data, callback): Promise<void>
Parameters
- file: File
- data: Data
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3383
writeFile(file, data, options, callback): Promise<void>
Parameters
- file: File
- data: Data
- options: Options
- callback: Callback
Returns Promise<void>
- Defined in src/EncryptedFS.ts:3388

`Static` createEncryptedFS

createEncryptedFS(__namedParameters): Promise<EncryptedFS>
Parameters
- __namedParameters: {
      blockSize?: number;
      dbKey: Buffer;
      dbPath: string;
      fdMgr?: FileDescriptorManager;
      fresh?: boolean;
      iNodeMgr?: INodeManager;
      logger?: Logger;
      umask?: number;
  }
  - Optional blockSize?: number
  - dbKey: Buffer
  - dbPath: string
  - Optional fdMgr?: FileDescriptorManager
  - Optional fresh?: boolean
  - Optional iNodeMgr?: INodeManager
  - Optional logger?: Logger
  - Optional umask?: number
Returns Promise<EncryptedFS>
- Defined in src/EncryptedFS.ts:40
createEncryptedFS(__namedParameters): Promise<EncryptedFS>
Parameters
- __namedParameters: {
      blockSize?: number;
      db: DB;
      fdMgr?: FileDescriptorManager;
      fresh?: boolean;
      iNodeMgr?: INodeManager;
      logger?: Logger;
      umask?: number;
  }
  - Optional blockSize?: number
  - db: DB
  - Optional fdMgr?: FileDescriptorManager
  - Optional fresh?: boolean
  - Optional iNodeMgr?: INodeManager
  - Optional logger?: Logger
  - Optional umask?: number
Returns Promise<EncryptedFS>
- Defined in src/EncryptedFS.ts:59

Class EncryptedFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { blockSize: number; chrootParent?: EncryptedFS; chroots?: Set<EncryptedFS>; crypto?: { key: Buffer; ops: Crypto; }; db: DB; dbOwned: boolean; fdMgr: FileDescriptorManager; iNodeMgr: INodeManager; iNodeMgrOwned: boolean; logger: Logger; rootIno: INodeIndex; umask: number; }

blockSize: number

Optional chrootParent?: EncryptedFS

Optional chroots?: Set<EncryptedFS>

Optional crypto?: { key: Buffer; ops: Crypto; }

key: Buffer

ops: Crypto

db: DB

dbOwned: boolean

fdMgr: FileDescriptorManager

iNodeMgr: INodeManager

iNodeMgrOwned: boolean

logger: Logger

rootIno: INodeIndex

umask: number

Returns EncryptedFS

Properties

Readonly [initLock]

Protected _cwd

Readonly blockSize

Protected Optional chrootParent

Protected chroots

Protected Optional crypto

Type declaration

key: Buffer

ops: Crypto

Protected db

Protected dbOwned

Protected fdMgr

gid

Protected iNodeMgr

Protected iNodeMgrOwned

Protected logger

Protected rootIno

uid

umask

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

constants

Returns constants

cwd

Returns string

promises

Returns this

Methods

Protected _open

Parameters

path: Path

flags: string | number

mode: number = permissions.DEFAULT_FILE_PERM

Optional tran: DBTransaction

Returns Promise<[FileDescriptor, FdIndex]>

__namedParameters: {
blockSize: number;
chrootParent?: EncryptedFS;
chroots?: Set<EncryptedFS>;
crypto?: {
key: Buffer;
ops: Crypto;
};
db: DB;
dbOwned: boolean;
fdMgr: FileDescriptorManager;
iNodeMgr: INodeManager;
iNodeMgrOwned: boolean;
logger: Logger;
rootIno: INodeIndex;
umask: number;
}

`Optional` chrootParent?: EncryptedFS

`Optional` chroots?: Set<EncryptedFS>

`Optional` crypto?: {
key: Buffer;
ops: Crypto;
}

`Readonly` [initLock]

`Protected` _cwd

`Readonly` blockSize

`Protected` `Optional` chrootParent

`Protected` chroots

`Protected` `Optional` crypto

`Protected` db

`Protected` dbOwned

`Protected` fdMgr

`Protected` iNodeMgr

`Protected` iNodeMgrOwned

`Protected` logger

`Protected` rootIno

`Protected` _open

`Optional` tran: DBTransaction

`Optional` mode: number

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: Options

`Protected` checkPermissions

`Optional` callback: Callback

`Optional` callback: Callback

`Optional` callback: Callback