Class default

This represents a FileSystem Structure for one objects that can open directories or files on the fly. This class is using FileSystemDirectory & FileSystemFile types from IFileSystem interface in order to accomplish this FileSystem structure.

Implements

IFileSystem

Index

Constructors

Methods

chmod createDir createFile exists readDir readFile readFileInChunks readlink rename rmdir stat supportsChunkedReading symlink unlink

Constructors

constructor

new default(rootDirectory?: FileSystemDirectory): default
Parameters
- rootDirectory: FileSystemDirectory = ...
Returns default
- Defined in fileSystems/TypesFileSystem.ts:49

Methods

chmod

chmod(pathName: string, _mode: number): Promise<number>
Not implemented because of Read Only FS
Parameters
- pathName: string
- _mode: number
Returns Promise<number>
Implementation of IFileSystem.chmod
- Defined in fileSystems/TypesFileSystem.ts:313

createDir

createDir(directoryPath: string, _dirMode: number): Promise<void>
The current Object File System is not supporting the creation of directories.
Parameters
- directoryPath: string
- _dirMode: number
Returns Promise<void>
Implementation of IFileSystem.createDir
- Defined in fileSystems/TypesFileSystem.ts:59

createFile

createFile(
    directoryPath: string,
    _fileHash: SHA256Hash<BLOB>,
    _fileName: string,
    _fileMode: number,
): Promise<void>
The current Object File System is not supporting the creation of files.
Parameters
- directoryPath: string
- _fileHash: SHA256Hash<BLOB>
- _fileName: string
- _fileMode: number
Returns Promise<void>
Implementation of IFileSystem.createFile
- Defined in fileSystems/TypesFileSystem.ts:123

exists

exists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
- Defined in fileSystems/TypesFileSystem.ts:207

readDir

readDir(dirPath: string): Promise<FileSystemDirectory>
Open directory. Paths are checked since it is a FS built on-the-fly.
Parameters
- dirPath: string
Returns Promise<FileSystemDirectory>
Implementation of IFileSystem.readDir
- Defined in fileSystems/TypesFileSystem.ts:149

readFile

readFile(filePath: string): Promise<FileSystemFile>
Opens the file on-the-fly.
Parameters
- filePath: string
Returns Promise<FileSystemFile>
Implementation of IFileSystem.readFile
- Defined in fileSystems/TypesFileSystem.ts:189

readFileInChunks

readFileInChunks(
    filePath: string,
    length: number,
    position: number,
): Promise<FileSystemFile>
Parameters
- filePath: string
- length: number
- position: number
Returns Promise<FileSystemFile>
Implementation of IFileSystem.readFileInChunks
- Defined in fileSystems/TypesFileSystem.ts:82

readlink

readlink(filePath: string): Promise<FileSystemFile>
Not implemented
Parameters
- filePath: string
Returns Promise<FileSystemFile>
Implementation of IFileSystem.readlink
- Defined in fileSystems/TypesFileSystem.ts:555

rename

rename(src: string, _dest: string): Promise<number>
Not implemented because of Read Only FS
Parameters
- src: string
- _dest: string
Returns Promise<number>
Implementation of IFileSystem.rename
- Defined in fileSystems/TypesFileSystem.ts:326

rmdir

rmdir(pathName: string): Promise<number>
Not implemented because of Read Only FS
Parameters
- pathName: string
Returns Promise<number>
Implementation of IFileSystem.rmdir
- Defined in fileSystems/TypesFileSystem.ts:338

stat

stat(path: string): Promise<FileDescription>
Parameters
- path: string
Returns Promise<FileDescription>
Implementation of IFileSystem.stat
- Defined in fileSystems/TypesFileSystem.ts:230

supportsChunkedReading

supportsChunkedReading(_path?: string): boolean
Parameters
- Optional_path: string
Returns boolean
Implementation of IFileSystem.supportsChunkedReading
- Defined in fileSystems/TypesFileSystem.ts:111

symlink

symlink(src: string, _dest: string): Promise<void>
Not implemented
Parameters
- src: string
- _dest: string
Returns Promise<void>
Implementation of IFileSystem.symlink
- Defined in fileSystems/TypesFileSystem.ts:542

unlink

unlink(pathName: string): Promise<number>
Not implemented because of Read Only FS
Parameters
- pathName: string
Returns Promise<number>
Implementation of IFileSystem.unlink
- Defined in fileSystems/TypesFileSystem.ts:350