Class default

This file systems provides pairing information so that other instances can pair to this instance.

Pairing information is provided as QR-Code and invite url as text. The following files exist:

/iom_invite.png: QR invite for IoM pairing - This will automatically create an IoM Request after successful pairing.
/iom_invite.txt: URL invite for IoM pairing - This will automatically create an IoM Request after successful pairing.
/iop_invite.png: QR invite for IoP pairing
/iop_invite.txt: URL invite for IoP pairing

Implements

IFileSystem

Index

Constructors

constructor

Methods

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

Constructors

constructor

new default(
    connectionsModel: ConnectionsModel,
    iomManager: default,
    inviteUrlPrefix: string,
    iomRequestMode?: "full" | "light",
): default
Constructor
Parameters
- connectionsModel: ConnectionsModel
- iomManager: default
- inviteUrlPrefix: string
- iomRequestMode: "full" | "light" = 'full'
Returns default
- Defined in fileSystems/PairingFileSystem.ts:56

Methods

chmod

chmod(pathName: 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
- pathName: string
  The file path
- mode: number
  The desired mode
Returns Promise<number>
- Returns 0 for success
Implementation of IFileSystem.chmod
- Defined in fileSystems/PairingFileSystem.ts:166

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
  The wanted mode for the wanted dir
Returns Promise<void>
Implementation of IFileSystem.createDir
- Defined in fileSystems/PairingFileSystem.ts:93

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>
  The BLOB file hash
- fileName: string
  The file name
- fileMode: number
  The file mode
Returns Promise<void>
Implementation of IFileSystem.createFile
- Defined in fileSystems/PairingFileSystem.ts:97

exists

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

readDir

readDir(dirPath: 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
- dirPath: string
  The directory path
Returns Promise<FileSystemDirectory>
- The content of the directory
Implementation of IFileSystem.readDir
- Defined in fileSystems/PairingFileSystem.ts:111

readFile

readFile(filePath: 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
- filePath: string
  The file path
Returns Promise<FileSystemFile>
- The content of the file
Implementation of IFileSystem.readFile
- Defined in fileSystems/PairingFileSystem.ts:122

readFileInChunks

readFileInChunks(
    filePath: 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
- filePath: string
  The file path
- length: number
- position: number
Returns Promise<FileSystemFile>
- The content of the file
Implementation of IFileSystem.readFileInChunks
- Defined in fileSystems/PairingFileSystem.ts:156

readlink

readlink(filePath: 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
- filePath: string
  The file path
Returns Promise<FileSystemFile>
- The content of the file
Implementation of IFileSystem.readlink
- Defined in fileSystems/PairingFileSystem.ts:205

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
  The src path
- dest: string
  The dest path
Returns Promise<number>
- Returns 0 for success
Implementation of IFileSystem.rename
- Defined in fileSystems/PairingFileSystem.ts:170

rmdir

rmdir(pathName: 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
- pathName: string
  the directory path
Returns Promise<number>
Returns 0 for success
Implementation of IFileSystem.rmdir
- Defined in fileSystems/PairingFileSystem.ts:174

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/PairingFileSystem.ts:182

supportsChunkedReading

supportsChunkedReading(path?: string): boolean
If file reading in chunks is supported on the current platform.
Parameters
- Optionalpath: string
Returns boolean
Implementation of IFileSystem.supportsChunkedReading
- Defined in fileSystems/PairingFileSystem.ts:213

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
  The dest path
Returns Promise<void>
- Returns 0 for success
Implementation of IFileSystem.symlink
- Defined in fileSystems/PairingFileSystem.ts:197

unlink

unlink(pathName: 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
- pathName: string
Returns Promise<number>
- Returns 0 for success
Implementation of IFileSystem.unlink
- Defined in fileSystems/PairingFileSystem.ts:178

Class default

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