Class WorkerFS

WorkerFS lets you access a BrowserFS instance that is running in a different JavaScript context (e.g. access BrowserFS in one of your WebWorkers, or access BrowserFS running on the main page from a WebWorker).

For example, to have a WebWorker access files in the main browser thread, do the following:

MAIN BROWSER THREAD:

  // Listen for remote file system requests.
  BrowserFS.Backend.WorkerFS.attachRemoteListener(webWorkerObject);

WEBWORKER THREAD:

  // Set the remote file system as the root file system.
  BrowserFS.configure({ fs: "WorkerFS", options: { worker: self }}, function(e) {
    // Ready!
  });

Note that synchronous operations are not permitted on the WorkerFS, regardless of the configuration option of the remote FS.

Hierarchy

BaseFileSystem
- WorkerFS

Constructors

constructor

new WorkerFS(__namedParameters): WorkerFS
Constructs a new WorkerFS instance that connects with BrowserFS running on the specified worker.
Parameters
- __namedParameters: WorkerFS.Options
Returns WorkerFS
Overrides BaseFileSystem.constructor
- Defined in src/backends/Worker.ts:121

Properties

`Private` _currentID

_currentID: number = 0

`Private` _isInitialized

_isInitialized: boolean = false

`Private` _metadata

_metadata: FileSystemMetadata

`Protected` _ready

_ready: Promise<WorkerFS>

`Private` _requests

_requests: Map<number, WorkerRequest> = ...

`Private` _worker

_worker: Worker

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "WorkerFS" = 'WorkerFS'

Accessors

metadata

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

Methods

`Private` _rpc

_rpc<T>(method, ...args): _RPCExtractReturnValue<T>
Type Parameters
- T extends "link" | "open" | "truncate" | "metadata" | "rename" | "whenReady" | "access" | "accessSync" | "renameSync" | "stat" | "statSync" | "openSync" | "unlink" | "unlinkSync" | "rmdir" | "rmdirSync" | "mkdir" | "mkdirSync" | "readdir" | "readdirSync" | "exists" | "existsSync" | "realpath" | "realpathSync" | "truncateSync" | "readFile" | "readFileSync" | "writeFile" | "writeFileSync" | "appendFile" | "appendFileSync" | "chmod" | "chmodSync" | "chown" | "chownSync" | "utimes" | "utimesSync" | "linkSync" | "symlink" | "symlinkSync" | "readlink" | "readlinkSync" | "syncClose"
Parameters
- method: T
- Rest ...args: (Extract<RPCMessage & {
      args: [srcpath: string, dstpath: string, cred: Cred];
      method: "link";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, flag: FileFlag, mode: number, cred: Cred];
      method: "open";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, len: number, cred: Cred];
      method: "truncate";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "metadata";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [oldPath: string, newPath: string, cred: Cred];
      method: "rename";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [];
      method: "whenReady";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, mode: number, cred: Cred];
      method: "access";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "accessSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "renameSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "stat";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "statSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "openSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "unlink";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "unlinkSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "rmdir";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "rmdirSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, mode: number, cred: Cred];
      method: "mkdir";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "mkdirSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "readdir";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "readdirSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "exists";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "existsSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "realpath";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "realpathSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "truncateSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [fname: string, flag: FileFlag, cred: Cred];
      method: "readFile";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "readFileSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred];
      method: "writeFile";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "writeFileSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [fname: string, data: Uint8Array, flag: FileFlag, mode: number, cred: Cred];
      method: "appendFile";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "appendFileSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, mode: number, cred: Cred];
      method: "chmod";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "chmodSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, new_uid: number, new_gid: number, cred: Cred];
      method: "chown";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "chownSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, atime: Date, mtime: Date, cred: Cred];
      method: "utimes";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "utimesSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "linkSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [srcpath: string, dstpath: string, type: string, cred: Cred];
      method: "symlink";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "symlinkSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [p: string, cred: Cred];
      method: "readlink";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: never;
      method: "readlinkSync";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [];
      method: "metadata";
  }, {
      method: T;
  }> | Extract<RPCMessage & {
      args: [string, File];
      method: "syncClose";
  }, {
      method: T;
  }>)["args"]
Returns _RPCExtractReturnValue<T>
- Defined in src/backends/Worker.ts:155

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>
Overrides BaseFileSystem.appendFile
- Defined in src/backends/Worker.ts:204

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>
Overrides BaseFileSystem.chmod
- Defined in src/backends/Worker.ts:207

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>
Overrides BaseFileSystem.chown
- Defined in src/backends/Worker.ts:210

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<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 Promise<File>
Inherited from BaseFileSystem.createFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:286

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/Worker.ts:189

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

link

link(srcpath, dstpath, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.link
- Defined in src/backends/Worker.ts:216

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: number
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.mkdir
- Defined in src/backends/Worker.ts:183

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

open

open(p, flag, mode, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<File>
Overrides BaseFileSystem.open
- Defined in src/backends/Worker.ts:174

openFile

openFile(p, flag, cred): Promise<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 Promise<File>
Inherited from BaseFileSystem.openFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:281

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>
Overrides BaseFileSystem.readFile
- Defined in src/backends/Worker.ts:198

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(p, cred): Promise<string[]>
Parameters
- p: string
- cred: Cred
Returns Promise<string[]>
Overrides BaseFileSystem.readdir
- Defined in src/backends/Worker.ts:186

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>
Overrides BaseFileSystem.readlink
- Defined in src/backends/Worker.ts:222

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>
Overrides BaseFileSystem.realpath
- Defined in src/backends/Worker.ts:192

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/Worker.ts:168

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(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.rmdir
- Defined in src/backends/Worker.ts:180

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(p, cred): Promise<Stats>
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Overrides BaseFileSystem.stat
- Defined in src/backends/Worker.ts:171

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>
Overrides BaseFileSystem.symlink
- Defined in src/backends/Worker.ts:219

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

syncClose

syncClose(method, fd): Promise<void>
Parameters
- method: string
- fd: File
Returns Promise<void>
- Defined in src/backends/Worker.ts:226

truncate

truncate(p, len, cred): Promise<void>
Parameters
- p: string
- len: number
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.truncate
- Defined in src/backends/Worker.ts:195

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(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.unlink
- Defined in src/backends/Worker.ts:177

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>
Overrides BaseFileSystem.utimes
- Defined in src/backends/Worker.ts:213

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<WorkerFS>
Returns Promise<WorkerFS>
Inherited from BaseFileSystem.whenReady
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:275

writeFile

writeFile(fname, data, flag, mode, cred): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.writeFile
- Defined in src/backends/Worker.ts:201

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/Worker.ts:106

Class WorkerFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: WorkerFS.Options

Returns WorkerFS

Properties

Private _currentID

Private _isInitialized

Private _metadata

Protected _ready

Private _requests

Private _worker

Static Create

Static Readonly Name

Accessors

metadata

Returns FileSystemMetadata

Methods

Private _rpc

Type Parameters

Parameters

method: T

Returns _RPCExtractReturnValue<T>

access

Parameters

p: string

mode: number

cred: Cred

Returns Promise<void>

accessSync

Parameters

p: string

mode: number

cred: Cred

Returns void

appendFile

Parameters

fname: string

data: Uint8Array

flag: FileFlag

mode: number

cred: Cred

Returns Promise<void>

appendFileSync

Parameters

fname: string

data: Uint8Array

flag: FileFlag

mode: number

cred: Cred

Returns void

chmod

Parameters

p: string

mode: number

cred: Cred

Returns Promise<void>

chmodSync

Parameters

p: string

mode: number

cred: Cred

Returns void

chown

Parameters

p: string

new_uid: number

new_gid: number

cred: Cred

Returns Promise<void>

chownSync

Parameters

p: string

`Private` _currentID

`Private` _isInitialized

`Private` _metadata

`Protected` _ready

`Private` _requests

`Private` _worker

`Static` Create

`Static` `Readonly` Name

`Private` _rpc