Class default

This is a convenience implementation for readonly file systems with small files.

Write support might be added later.

In order to use it you only have to specify the directory structure as a hierarchy of maps, like

    super();
    this.setRootDirectory(
        new Map<string, EasyDirectoryEntry>([
            ['chats.json', {type: 'regularFile', content: this.loadTopics.bind(this)}],
            ['channels.json', {type: 'regularFile', content: this.loadChannels.bind(this)}],
            ['chats', {type: 'directory', content: new Map()}]
        ])
    );

Hierarchy (View Summary)

default

Implements

IFileSystem

Index

Constructors

constructor

Methods

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

Constructors

constructor

new default(escapeFileNames?: boolean): default
Constructor
Parameters
- escapeFileNames: boolean = false
Returns default
- Defined in fileSystems/utils/EasyFileSystem.ts:56

Methods

chmod

chmod(path: string, _mode: number): Promise<number>
Change the permissions.

Can throw:
- FS_ERRORS.FSE-ENOENT when the parent dir does not exist or the given mode is not a file type
- FS_ERRORS.FSE-EACCES-W if the parent directory does not have write permission
Parameters
- path: string
- _mode: number
Returns Promise<number>
- Returns 0 for success
Implementation of IFileSystem.chmod
- Defined in fileSystems/utils/EasyFileSystem.ts:141

createDir

createDir(directoryPath: string, _dirMode: number): Promise<void>
Creates a directory.

Can throw:
- FS_ERRORS.FSE-ENOENT when the parent dir does not exist or the given mode is not a dir type
- FS_ERRORS.FSE-EXISTS when the current path already exists
- FS_ERRORS.FSE-EACCES-W if the parent directory does not have write permission
Parameters
- directoryPath: string
  The wanted dir path
- _dirMode: number
Returns Promise<void>
Implementation of IFileSystem.createDir
- Defined in fileSystems/utils/EasyFileSystem.ts:71

createFile

createFile(
    directoryPath: string,
    _fileHash: SHA256Hash<BLOB>,
    _fileName: string,
    _fileMode: number,
): Promise<void>
Creates a file otherwise

Can throw:
- FS_ERRORS.FSE-ENOENT when the parent dir does not exist or the given mode is not a file type
- FS_ERRORS.FSE-EXISTS when the current path already exists
- FS_ERRORS.FSE-EACCES-W if the parent directory does not have write permission
Parameters
- directoryPath: string
  The directory where the file will be saved
- _fileHash: SHA256Hash<BLOB>
- _fileName: string
- _fileMode: number
Returns Promise<void>
Implementation of IFileSystem.createFile
- Defined in fileSystems/utils/EasyFileSystem.ts:75

exists

exists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
- Defined in fileSystems/utils/EasyFileSystem.ts:84

readDir

readDir(path: string): Promise<FileSystemDirectory>
Reads a directory.

Can throw:
- FS_ERRORS.FSE-ENOENT if the directory does not exist
- FS_ERRORS.FSE-EACCES-R if the directory does not have read permission
Parameters
- path: string
Returns Promise<FileSystemDirectory>
- The content of the directory
Implementation of IFileSystem.readDir
- Defined in fileSystems/utils/EasyFileSystem.ts:89

readFile

readFile(path: string): Promise<FileSystemFile>
Reads a file.

Can throw:
- FS_ERRORS.FSE-ENOENT if the file does not exist
- FS_ERRORS.FSE-EACCES-R if the file does not have read permission
Parameters
- path: string
Returns Promise<FileSystemFile>
- The content of the file
Implementation of IFileSystem.readFile
- Defined in fileSystems/utils/EasyFileSystem.ts:108

readFileInChunks

readFileInChunks(
    path: string,
    length: number,
    position: number,
): Promise<FileSystemFile>
Reads a file in chunks by a given len and position.

Can throw:
- FS_ERRORS.FSE-CHUNK-R if the platform does not support chunked reading. This is supported only on Node. This happen if the check for Platform is not nodejs.
- FS_ERRORS.FSE-ENOENT if the file does not exist
- FS_ERRORS.FSE-EACCES-R if the file does not have read permission
Parameters
- path: string
- length: number
- position: number
Returns Promise<FileSystemFile>
- The content of the file
Implementation of IFileSystem.readFileInChunks
- Defined in fileSystems/utils/EasyFileSystem.ts:131

readlink

readlink(path: string): Promise<FileSystemFile>
Reads a link.

Can throw:
- FS_ERRORS.FSE-ENOENT if the file does not exist
- FS_ERRORS.FSE-EACCES-R if the file does not have read permission
Parameters
- path: string
Returns Promise<FileSystemFile>
- The content of the file
Implementation of IFileSystem.readlink
- Defined in fileSystems/utils/EasyFileSystem.ts:185

rename

rename(_src: string, dest: string): Promise<number>
Rename file.

Can throw:
- FS_ERRORS.FSE-ENOENT when the parent dir does not exist or the given mode is not a file type
- FS_ERRORS.FSE-EACCES-W if the parent directory does not have write permission
Parameters
- _src: string
- dest: string
  The dest path
Returns Promise<number>
- Returns 0 for success
Implementation of IFileSystem.rename
- Defined in fileSystems/utils/EasyFileSystem.ts:145

rmdir

rmdir(path: string): Promise<number>
Deletes a directory

Can throw:
- FS_ERRORS.FSE-ENOENT if the dir does not exist
- FS_ERRORS.FSE-EACCES-W if the dir does not have write permission
Parameters
- path: string
Returns Promise<number>
Returns 0 for success
Implementation of IFileSystem.rmdir
- Defined in fileSystems/utils/EasyFileSystem.ts:149

stat

stat(path: string): Promise<FileDescription>
Stat a file.

Can throw:
- FS_ERRORS.FSE-ENOENT if the file does not exist
Parameters
- path: string
Returns Promise<FileDescription>
- The content of the file
Implementation of IFileSystem.stat
- Defined in fileSystems/utils/EasyFileSystem.ts:157

supportsChunkedReading

supportsChunkedReading(_path?: string): boolean
If file reading in chunks is supported on the current platform.
Parameters
- Optional_path: string
Returns boolean
Implementation of IFileSystem.supportsChunkedReading
- Defined in fileSystems/utils/EasyFileSystem.ts:199

symlink

symlink(src: string, _dest: string): Promise<void>
Creates a symlink.

Can throw:
- FS_ERRORS.FSE-ENOENT when the parent dir does not exist or the given mode is not a file type
- FS_ERRORS.FSE-EXISTS when the current path already exists
- FS_ERRORS.FSE-EACCES-W if the parent directory does not have write permission
Parameters
- src: string
  The src path
- _dest: string
Returns Promise<void>
- Returns 0 for success
Implementation of IFileSystem.symlink
- Defined in fileSystems/utils/EasyFileSystem.ts:177

unlink

unlink(path: string): Promise<number>
Deletes a file or a symlink.

Can throw:
- FS_ERRORS.FSE-ENOENT if the file does not exist
- FS_ERRORS.FSE-EACCES-W if the file does not have write permission
Parameters
- path: string
Returns Promise<number>
- Returns 0 for success
Implementation of IFileSystem.unlink
- Defined in fileSystems/utils/EasyFileSystem.ts:153

Class default

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

chmod

Parameters

Returns Promise<number>

createDir

Parameters

Returns Promise<void>

createFile

Parameters

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

readDir

Parameters

Returns Promise<FileSystemDirectory>

readFile

Parameters

Returns Promise<FileSystemFile>

readFileInChunks

Parameters

Returns Promise<FileSystemFile>

readlink

Parameters

Returns Promise<FileSystemFile>

rename

Parameters

Returns Promise<number>

rmdir

Parameters

Returns Promise<number>

stat

Parameters

Returns Promise<FileDescription>

supportsChunkedReading

Parameters

Returns boolean

symlink

Parameters

Returns Promise<void>

unlink

Parameters

Returns Promise<number>

Settings

On This Page