Class default

constructor

• new default(rootDirectory, storage?): default

• Parameters

  • rootDirectory: PersistentFileSystemRoot
  • Optionalstorage: string

  Returns default

onFilePersisted

onRootUpdate

updateRoot

• set updateRoot(rootDirectory): void

• Parameters

  • rootDirectory: PersistentFileSystemRoot

  Returns void

chmod

• chmod(pathName, mode): 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

createDir

• createDir(directoryPath, dirMode?): Promise<void>

• Parameters

  • directoryPath: string
  • dirMode: number = 0o0040777

  Returns Promise<void>

createFile

• createFile(directoryPath, fileHash, fileName, fileMode?): 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>

exists

• exists(path): Promise<boolean>

• Parameters

  • path: string

  Returns Promise<boolean>

readDir

• readDir(path): Promise<FileSystemDirectory>

• Parameters

  • path: string

  Returns Promise<FileSystemDirectory>

readFile

• readFile(filePath): Promise<FileSystemFile>

• Checks if a file exists or not.

  Parameters

  • filePath: string

  Returns Promise<FileSystemFile>

readFileInChunks

• readFileInChunks(filePath, length, position): Promise<FileSystemFile>

• Parameters

  • filePath: string
  • length: number
  • position: number

  Returns Promise<FileSystemFile>

readlink

• readlink(filePath): Promise<FileSystemFile>

• Reads a symlink. Return 0 for success or an error code and the pointed path

  Parameters

  • filePath: string

  Returns Promise<FileSystemFile>

rename

• rename(src, dest): 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

rmdir

• rmdir(pathName): Promise<number>

• Removes the directory

  Parameters

  • pathName: string

  Returns Promise<number>

stat

• stat(path): Promise<FileDescription>

• Parameters

  • path: string

  Returns Promise<FileDescription>

supportsChunkedReading

• supportsChunkedReading(_path?): boolean

• If file reading in chunks is supported on the current platform.

  Parameters

  • Optional_path: string

  Returns boolean

symlink

• symlink(src, dest): Promise<void>

• Creates a symlink. Return 0 for success or an error code

  Parameters

  • src: string
  • dest: string

  Returns Promise<void>

unlink

• unlink(pathName): 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