Class FileSystemAccessFileSystem

Hierarchy

BaseFileSystem
- FileSystemAccessFileSystem

Constructors

constructor

new FileSystemAccessFileSystem(__namedParameters): FileSystemAccessFileSystem
Parameters
- __namedParameters: FileSystemAccessFileSystemOptions
Returns FileSystemAccessFileSystem
Overrides BaseFileSystem.constructor
- Defined in src/backends/FileSystemAccess.ts:60

Properties

`Private` _handles

_handles: Map<string, FileSystemHandle> = ...

`Protected` _ready

_ready: Promise<FileSystemAccessFileSystem>

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "FileSystemAccess" = 'FileSystemAccess'

`Static` `Readonly` Options

Options: BackendOptions = {}

Accessors

metadata

get metadata(): FileSystemMetadata
Returns FileSystemMetadata
Overrides BaseFileSystem.metadata
- Defined in src/backends/FileSystemAccess.ts:65

Methods

_sync

_sync(p, data, stats, cred): Promise<void>
Parameters
- p: string
- data: Uint8Array
- stats: Stats
- cred: Cred
Returns Promise<void>
- Defined in src/backends/FileSystemAccess.ts:72

access

access(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.access
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:288

accessSync

accessSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.accessSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:289

appendFile

appendFile(fname, data, flag, mode, cred): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.appendFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:325

appendFileSync

appendFileSync(fname, data, flag, mode, cred): void
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.appendFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:326

chmod

chmod(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.chmod
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:327

chmodSync

chmodSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.chmodSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:328

chown

chown(p, new_uid, new_gid, cred): Promise<void>
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.chown
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:329

chownSync

chownSync(p, new_uid, new_gid, cred): void
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.chownSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:330

createFile

createFile(p, flag, mode, cred): Promise<FileSystemAccessFile>
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<FileSystemAccessFile>
Overrides BaseFileSystem.createFile
- Defined in src/backends/FileSystemAccess.ts:124

createFileSync

createFileSync(p, flag, mode, cred): File
Create the file at path p with the given mode. Then, open it with the given flag.
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns File
Inherited from BaseFileSystem.createFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:305

exists

exists(p, cred): Promise<boolean>
Parameters
- p: string
- cred: Cred
Returns Promise<boolean>
Overrides BaseFileSystem.exists
- Defined in src/backends/FileSystemAccess.ts:143

existsSync

existsSync(p, cred): boolean
Parameters
- p: string
- cred: Cred
Returns boolean
Inherited from BaseFileSystem.existsSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:316

`Private` getHandle

getHandle(path): Promise<FileSystemHandle>
Parameters
- path: string
Returns Promise<FileSystemHandle>
- Defined in src/backends/FileSystemAccess.ts:206

link

link(srcpath, dstpath, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.link
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:333

linkSync

linkSync(srcpath, dstpath, cred): void
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.linkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:334

mkdir

mkdir(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: any
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.mkdir
- Defined in src/backends/FileSystemAccess.ts:176

mkdirSync

mkdirSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.mkdirSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:312

`Private` newFile

newFile(path, flag, data, size?, lastModified?): FileSystemAccessFile
Parameters
- path: string
- flag: FileFlag
- data: ArrayBuffer
- Optional size: number
- Optional lastModified: number
Returns FileSystemAccessFile
- Defined in src/backends/FileSystemAccess.ts:202

open

open(p, flag, mode, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<File>
Inherited from BaseFileSystem.open
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:287

openFile

openFile(path, flags, cred): Promise<FileSystemAccessFile>
Parameters
- path: string
- flags: FileFlag
- cred: Cred
Returns Promise<FileSystemAccessFile>
Overrides BaseFileSystem.openFile
- Defined in src/backends/FileSystemAccess.ts:152

openFileSync

openFileSync(p, flag, cred): File
Opens the file at path p with the given flag. The file must exist.
Parameters
- p: string
  
  The path to open.
- flag: FileFlag
  
  The flag to use when opening the file.
- cred: Cred
Returns File
A File object corresponding to the opened file.
Inherited from BaseFileSystem.openFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:300

openSync

openSync(p, flag, mode, cred): File
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns File
Inherited from BaseFileSystem.openSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:306

readFile

readFile(fname, flag, cred): Promise<Uint8Array>
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Promise<Uint8Array>
Inherited from BaseFileSystem.readFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:321

readFileSync

readFileSync(fname, flag, cred): Uint8Array
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Uint8Array
Inherited from BaseFileSystem.readFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:322

readdir

readdir(path, cred): Promise<string[]>
Parameters
- path: string
- cred: Cred
Returns Promise<string[]>
Overrides BaseFileSystem.readdir
- Defined in src/backends/FileSystemAccess.ts:190

readdirSync

readdirSync(p, cred): string[]
Parameters
- p: string
- cred: Cred
Returns string[]
Inherited from BaseFileSystem.readdirSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:314

readlink

readlink(p, cred): Promise<string>
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from BaseFileSystem.readlink
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:337

readlinkSync

readlinkSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from BaseFileSystem.readlinkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:338

realpath

realpath(p, cred): Promise<string>
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from BaseFileSystem.realpath
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:317

realpathSync

realpathSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from BaseFileSystem.realpathSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:318

rename

rename(oldPath, newPath, cred): Promise<void>
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.rename
- Defined in src/backends/FileSystemAccess.ts:79

renameSync

renameSync(oldPath, newPath, cred): void
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.renameSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:291

rmdir

rmdir(path, cred): Promise<void>
Parameters
- path: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.rmdir
- Defined in src/backends/FileSystemAccess.ts:172

rmdirSync

rmdirSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.rmdirSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:310

stat

stat(path, cred): Promise<Stats>
Parameters
- path: string
- cred: Cred
Returns Promise<Stats>
Overrides BaseFileSystem.stat
- Defined in src/backends/FileSystemAccess.ts:129

statSync

statSync(p, cred): Stats
Parameters
- p: string
- cred: Cred
Returns Stats
Inherited from BaseFileSystem.statSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:293

symlink

symlink(srcpath, dstpath, type, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.symlink
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:335

symlinkSync

symlinkSync(srcpath, dstpath, type, cred): void
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.symlinkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:336

truncate

truncate(p, len, cred): Promise<void>
Parameters
- p: string
- len: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.truncate
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:319

truncateSync

truncateSync(p, len, cred): void
Parameters
- p: string
- len: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.truncateSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:320

unlink

unlink(path, cred): Promise<void>
Parameters
- path: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.unlink
- Defined in src/backends/FileSystemAccess.ts:161

unlinkSync

unlinkSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.unlinkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:308

utimes

utimes(p, atime, mtime, cred): Promise<void>
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.utimes
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:331

utimesSync

utimesSync(p, atime, mtime, cred): void
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns void
Inherited from BaseFileSystem.utimesSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:332

whenReady

whenReady(): Promise<FileSystemAccessFileSystem>
Returns Promise<FileSystemAccessFileSystem>
Inherited from BaseFileSystem.whenReady
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:275

writeFile

writeFile(fname, data, flag, mode, cred, createFile?): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
- Optional createFile: boolean
Returns Promise<void>
Overrides BaseFileSystem.writeFile
- Defined in src/backends/FileSystemAccess.ts:113

writeFileSync

writeFileSync(fname, data, flag, mode, cred): void
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.writeFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:324

`Static` isAvailable

isAvailable(): boolean
Returns boolean
- Defined in src/backends/FileSystemAccess.ts:54

Generated using TypeDoc