Class FileSystemAbstract

constructor

• new FileSystem(options?): FileSystem

• Parameters

  • Optional options: object

  Returns FileSystem

Readonly Abstract metadata

Static Readonly Name

Abstract access

• access(p, mode, cred): Promise<void>

• Asynchronous access.

  Parameters

  • p: string

  • mode: number

  • cred: Cred

  Returns Promise<void>

Abstract accessSync

• accessSync(p, mode, cred): void

• Synchronous access.

  Parameters

  • p: string

  • mode: number

  • cred: Cred

  Returns void

Abstract appendFile

• appendFile(fname, data, flag, mode, cred): Promise<void>

• Asynchronously append data to a file, creating the file if it not yet exists.

  Parameters

  • fname: string

  • data: Uint8Array

  • flag: FileFlag

  • mode: number

  • cred: Cred

  Returns Promise<void>

Abstract appendFileSync

• appendFileSync(fname, data, flag, mode, cred): void

• Synchronously append data to a file, creating the file if it not yet exists.

  Parameters

  • fname: string

  • data: Uint8Array

  • flag: FileFlag

  • mode: number

  • cred: Cred

  Returns void

Abstract chmod

• chmod(p, mode, cred): Promise<void>

• Asynchronous chmod.

  Parameters

  • p: string

  • mode: number

  • cred: Cred

  Returns Promise<void>

Abstract chmodSync

• chmodSync(p, mode, cred): void

• Synchronous chmod.

  Parameters

  • p: string

  • mode: number

  • cred: Cred

  Returns void

Abstract chown

• chown(p, new_uid, new_gid, cred): Promise<void>

• Asynchronous chown.

  Parameters

  • p: string

  • new_uid: number

  • new_gid: number

  • cred: Cred

  Returns Promise<void>

Abstract chownSync

• chownSync(p, new_uid, new_gid, cred): void

• Synchronous chown.

  Parameters

  • p: string

  • new_uid: number

  • new_gid: number

  • cred: Cred

  Returns void

Abstract exists

• exists(p, cred): Promise<boolean>

• Test whether or not the given path exists by checking with the file system. Then call the callback argument with either true or false.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<boolean>

Abstract existsSync

• existsSync(p, cred): boolean

• Test whether or not the given path exists by checking with the file system.

  Parameters

  • p: string

  • cred: Cred

  Returns boolean

Abstract link

• link(srcpath, dstpath, cred): Promise<void>

• Asynchronous link.

  Parameters

  • srcpath: string

  • dstpath: string

  • cred: Cred

  Returns Promise<void>

Abstract linkSync

• linkSync(srcpath, dstpath, cred): void

• Synchronous link.

  Parameters

  • srcpath: string

  • dstpath: string

  • cred: Cred

  Returns void

Abstract mkdir

• mkdir(p, mode, cred): Promise<void>

• Asynchronous mkdir.

  Parameters

  • p: string

  • mode: number

    Mode to make the directory using. Can be ignored if the filesystem doesn't support permissions.

  • cred: Cred

  Returns Promise<void>

Abstract mkdirSync

• mkdirSync(p, mode, cred): void

• Synchronous mkdir.

  Parameters

  • p: string

  • mode: number

    Mode to make the directory using. Can be ignored if the filesystem doesn't support permissions.

  • cred: Cred

  Returns void

Abstract open

• open(p, flag, mode, cred): Promise<File>

• Asynchronous file open.

  Parameters

  • p: string

  • flag: FileFlag

  • mode: number

    Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.

  • cred: Cred

  Returns Promise<File>

  See

  http://www.manpagez.com/man/2/open/

Abstract openSync

• openSync(p, flag, mode, cred): File

• Synchronous file open.

  Parameters

  • p: string

  • flag: FileFlag

  • mode: number

    Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.

  • cred: Cred

  Returns File

  See

  http://www.manpagez.com/man/2/open/

Abstract readFile

• readFile(fname, flag, cred): Promise<Uint8Array>

• Asynchronously reads the entire contents of a file.

  Parameters

  • fname: string

  • flag: FileFlag

  • cred: Cred

  Returns Promise<Uint8Array>

Abstract readFileSync

• readFileSync(fname, flag, cred): Uint8Array

• Synchronously reads the entire contents of a file.

  Parameters

  • fname: string

  • flag: FileFlag

  • cred: Cred

  Returns Uint8Array

Abstract readdir

• readdir(p, cred): Promise<string[]>

• Asynchronous readdir. Reads the contents of a directory.

  The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<string[]>

Abstract readdirSync

• readdirSync(p, cred): string[]

• Synchronous readdir. Reads the contents of a directory.

  Parameters

  • p: string

  • cred: Cred

  Returns string[]

Abstract readlink

• readlink(p, cred): Promise<string>

• Asynchronous readlink.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<string>

Abstract readlinkSync

• readlinkSync(p, cred): string

• Synchronous readlink.

  Parameters

  • p: string

  • cred: Cred

  Returns string

Abstract realpath

• realpath(p, cred): Promise<string>

• Asynchronous realpath. The callback gets two arguments (err, resolvedPath).

  Note that the Node API will resolve path to an absolute path.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<string>

Abstract realpathSync

• realpathSync(p, cred): string

• Synchronous realpath.

  Note that the Node API will resolve path to an absolute path.

  Parameters

  • p: string

  • cred: Cred

  Returns string

Abstract rename

• rename(oldPath, newPath, cred): Promise<void>

• Asynchronous rename. No arguments other than a possible exception are given to the completion callback.

  Parameters

  • oldPath: string

  • newPath: string

  • cred: Cred

  Returns Promise<void>

Abstract renameSync

• renameSync(oldPath, newPath, cred): void

• Synchronous rename.

  Parameters

  • oldPath: string

  • newPath: string

  • cred: Cred

  Returns void

Abstract rmdir

• rmdir(p, cred): Promise<void>

• Asynchronous rmdir.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<void>

Abstract rmdirSync

• rmdirSync(p, cred): void

• Synchronous rmdir.

  Parameters

  • p: string

  • cred: Cred

  Returns void

Abstract stat

• stat(p, cred): Promise<Stats>

• Asynchronous stat.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<Stats>

Abstract statSync

• statSync(p, cred): Stats

• Synchronous stat.

  Parameters

  • p: string

  • cred: Cred

  Returns Stats

Abstract symlink

• symlink(srcpath, dstpath, type, cred): Promise<void>

• Asynchronous symlink.

  Parameters

  • srcpath: string

  • dstpath: string

  • type: string

    can be either 'dir' or 'file'

  • cred: Cred

  Returns Promise<void>

Abstract symlinkSync

• symlinkSync(srcpath, dstpath, type, cred): void

• Synchronous symlink.

  Parameters

  • srcpath: string

  • dstpath: string

  • type: string

    can be either 'dir' or 'file'

  • cred: Cred

  Returns void

Abstract truncate

• truncate(p, len, cred): Promise<void>

• Asynchronous truncate.

  Parameters

  • p: string

  • len: number

  • cred: Cred

  Returns Promise<void>

Abstract truncateSync

• truncateSync(p, len, cred): void

• Synchronous truncate.

  Parameters

  • p: string

  • len: number

  • cred: Cred

  Returns void

Abstract unlink

• unlink(p, cred): Promise<void>

• Asynchronous unlink.

  Parameters

  • p: string

  • cred: Cred

  Returns Promise<void>

Abstract unlinkSync

• unlinkSync(p, cred): void

• Synchronous unlink.

  Parameters

  • p: string

  • cred: Cred

  Returns void

Abstract utimes

• utimes(p, atime, mtime, cred): Promise<void>

• Change file timestamps of the file referenced by the supplied path.

  Parameters

  • p: string

  • atime: Date

  • mtime: Date

  • cred: Cred

  Returns Promise<void>

Abstract utimesSync

• utimesSync(p, atime, mtime, cred): void

• Change file timestamps of the file referenced by the supplied path.

  Parameters

  • p: string

  • atime: Date

  • mtime: Date

  • cred: Cred

  Returns void

Abstract whenReady

• whenReady(): Promise<FileSystem>

• Returns Promise<FileSystem>

Abstract writeFile

• writeFile(fname, data, flag, mode, cred): Promise<void>

• Asynchronously writes data to a file, replacing the file if it already exists.

  The encoding option is ignored if data is a buffer.

  Parameters

  • fname: string

  • data: Uint8Array

  • flag: FileFlag

  • mode: number

  • cred: Cred

  Returns Promise<void>

Abstract writeFileSync

• writeFileSync(fname, data, flag, mode, cred): void

• Synchronously writes data to a file, replacing the file if it already exists.

  The encoding option is ignored if data is a buffer.

  Parameters

  • fname: string

  • data: Uint8Array

  • flag: FileFlag

  • mode: number

  • cred: Cred

  Returns void