Class default

This represents a special File System that maps the given path to the specific file system implementation

Implements

IFileSystem

Index

Constructors

Methods

chmod createDir createFile getRootDirContents isRootPath mountFileSystem readDir readFile readFileInChunks readlink rename rmdir search stat supportsChunkedReading symlink unlink unmountFileSystem

Constructors

constructor

new default(): default
Returns default

Methods

chmod

chmod(pathName: string, mode: number): Promise<number>
Parameters
- pathName: string
- mode: number
Returns Promise<number>
Implementation of IFileSystem.chmod
- Defined in fileSystems/TemporaryFileSystem.ts:278

createDir

createDir(directoryPath: string, dirMode?: number): Promise<void>
Parameters
- directoryPath: string
- dirMode: number = 0o0040777
Returns Promise<void>
Implementation of IFileSystem.createDir
- Defined in fileSystems/TemporaryFileSystem.ts:83

createFile

createFile(
    directoryPath: string,
    fileHash: SHA256Hash<BLOB>,
    fileName: string,
    fileMode?: number,
): Promise<void>
Overwrites a file if the file already exist in the folder, otherwise, adds the file.
Parameters
- directoryPath: string
- fileHash: SHA256Hash<BLOB>
- fileName: string
- fileMode: number = 0o0100666
Returns Promise<void>
Implementation of IFileSystem.createFile
- Defined in fileSystems/TemporaryFileSystem.ts:115

getRootDirContents

getRootDirContents(): FileSystemDirectory
Returns FileSystemDirectory
- Defined in fileSystems/TemporaryFileSystem.ts:393

isRootPath

isRootPath(checkPath: string): boolean
Parameters
- checkPath: string
Returns boolean
- Defined in fileSystems/TemporaryFileSystem.ts:495

mountFileSystem

mountFileSystem(storagePath: string, fileSystem: IFileSystem): Promise<0>
Attaches a filesystem to a directory. It will return 0 for success or reject the promise.
Parameters
- storagePath: string
- fileSystem: IFileSystem
Returns Promise<0>
- Defined in fileSystems/TemporaryFileSystem.ts:38

readDir

readDir(checkPath: string): Promise<FileSystemDirectory>
Parameters
- checkPath: string
Returns Promise<FileSystemDirectory>
Implementation of IFileSystem.readDir
- Defined in fileSystems/TemporaryFileSystem.ts:239

readFile

readFile(filePath: string): Promise<FileSystemFile>
Checks if a file exists or not.
Parameters
- filePath: string
Returns Promise<FileSystemFile>
Implementation of IFileSystem.readFile
- Defined in fileSystems/TemporaryFileSystem.ts:150

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/TemporaryFileSystem.ts:178

readlink

readlink(filePath: string): Promise<FileSystemFile>
Reads a symlink. Return 0 for success or an error code and the pointed path
Parameters
- filePath: string
Returns Promise<FileSystemFile>
Implementation of IFileSystem.readlink
- Defined in fileSystems/TemporaryFileSystem.ts:473

rename

rename(src: string, dest: string): Promise<number>
Parameters
- src: string
- dest: string
Returns Promise<number>
Implementation of IFileSystem.rename
- Defined in fileSystems/TemporaryFileSystem.ts:304

rmdir

rmdir(pathName: string): Promise<number>
Parameters
- pathName: string
Returns Promise<number>
Implementation of IFileSystem.rmdir
- Defined in fileSystems/TemporaryFileSystem.ts:342

search

search(
checkPath: string,
): null | { fileSystem: IFileSystem; relativePath: string }
Parameters
- checkPath: string
Returns null | { fileSystem: IFileSystem; relativePath: string }
- Defined in fileSystems/TemporaryFileSystem.ts:412

stat

stat(checkPath: string): Promise<FileDescription>
Parameters
- checkPath: string
Returns Promise<FileDescription>
Implementation of IFileSystem.stat
- Defined in fileSystems/TemporaryFileSystem.ts:260

supportsChunkedReading

supportsChunkedReading(filePath: string): boolean
Parameters
- filePath: string
Returns boolean
Implementation of IFileSystem.supportsChunkedReading
- Defined in fileSystems/TemporaryFileSystem.ts:217

symlink

symlink(src: string, dest: string): Promise<void>
Creates a symlink. Return 0 for success or an error code
Parameters
- src: string
- dest: string
Returns Promise<void>
Implementation of IFileSystem.symlink
- Defined in fileSystems/TemporaryFileSystem.ts:444

unlink

unlink(pathName: string): Promise<number>
Parameters
- pathName: string
Returns Promise<number>
Implementation of IFileSystem.unlink
- Defined in fileSystems/TemporaryFileSystem.ts:367

unmountFileSystem

unmountFileSystem(storagePath: string): Promise<0>
Attaches a filesystem to a directory. It will return 0 for success or reject the promise.
Parameters
- storagePath: string
Returns Promise<0>
- Defined in fileSystems/TemporaryFileSystem.ts:66