Class FolderAdapter

The FolderAdapter file system wraps a file system, and scopes all interactions to a subfolder of that file system.

Example: Given a file system foo with folder bar and file bar/baz...

BrowserFS.configure({
  fs: "FolderAdapter",
  options: {
    folder: "bar",
    wrapped: foo
  }
}, function(e) {
  var fs = BrowserFS.BFSRequire('fs');
  fs.readdirSync('/'); // ['baz']
});

Hierarchy

BaseFileSystem
- FolderAdapter

Constructors

constructor

new FolderAdapter(__namedParameters): FolderAdapter
Parameters
- __namedParameters: FolderAdapter.Options
Returns FolderAdapter
Overrides BaseFileSystem.constructor
- Defined in src/backends/FolderAdapter.ts:60

Properties

_folder

_folder: string

`Protected` _ready

_ready: Promise<FolderAdapter> = ...

_wrapped

_wrapped: FileSystem

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "FolderAdapter" = 'FolderAdapter'

Accessors

metadata

get metadata(): {
    freeSpace: number;
    name: string;
    readonly: boolean;
    supportsLinks: boolean;
    supportsProperties: boolean;
    synchronous: boolean;
    totalSpace: number;
}
Returns {
    freeSpace: number;
    name: string;
    readonly: boolean;
    supportsLinks: boolean;
    supportsProperties: boolean;
    synchronous: boolean;
    totalSpace: number;
}
- freeSpace: number
  
  The available space
- name: string
  
  The name of the FS
- readonly: boolean
  
  Wheter the FS is readonly or not
- supportsLinks: boolean
- supportsProperties: boolean
  
  Does the FS support properties
- synchronous: boolean
  
  Does the FS support synchronous operations
- totalSpace: number
  
  The total space
Overrides BaseFileSystem.metadata
- Defined in src/backends/FolderAdapter.ts:67

Methods

`Private` _initialize

_initialize(): Promise<FolderAdapter>
Initialize the file system. Ensures that the wrapped file system has the given folder.

Returns Promise<FolderAdapter>
- Defined in src/backends/FolderAdapter.ts:75

access

access(p, mode, cred): Promise<void>
Asynchronous access.
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.access
- Defined in src/filesystem.ts:381

accessSync

accessSync(p, mode, cred): void
Synchronous access.
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.accessSync
- Defined in src/filesystem.ts:384

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>
Inherited from BaseFileSystem.appendFile
- Defined in src/filesystem.ts:608

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
Inherited from BaseFileSystem.appendFileSync
- Defined in src/filesystem.ts:619

chmod

chmod(p, mode, cred): Promise<void>
Asynchronous chmod.
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.chmod
- Defined in src/filesystem.ts:630

chmodSync

chmodSync(p, mode, cred): void
Synchronous chmod.
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.chmodSync
- Defined in src/filesystem.ts:633

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>
Inherited from BaseFileSystem.chown
- Defined in src/filesystem.ts:636

chownSync

chownSync(p, new_uid, new_gid, cred): void
Synchronous chown.
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.chownSync
- Defined in src/filesystem.ts:639

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 src/filesystem.ts:338

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 src/filesystem.ts:412

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>
Inherited from BaseFileSystem.exists
- Defined in src/filesystem.ts:482

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
Inherited from BaseFileSystem.existsSync
- Defined in src/filesystem.ts:490

link

link(srcpath, dstpath, cred): Promise<void>
Asynchronous link.
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.link
- Defined in src/filesystem.ts:648

linkSync

linkSync(srcpath, dstpath, cred): void
Synchronous link.
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.linkSync
- Defined in src/filesystem.ts:651

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>
Inherited from BaseFileSystem.mkdir
- Defined in src/filesystem.ts:470

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
Inherited from BaseFileSystem.mkdirSync
- Defined in src/filesystem.ts:473

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/
Inherited from BaseFileSystem.open
- Defined in src/filesystem.ts:341

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 src/filesystem.ts:331

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 src/filesystem.ts:405

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/
Inherited from BaseFileSystem.openSync
- Defined in src/filesystem.ts:415

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>
Inherited from BaseFileSystem.readFile
- Defined in src/filesystem.ts:554

readFileSync

readFileSync(fname, flag, cred): Uint8Array
Synchronously reads the entire contents of a file.
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Uint8Array
Inherited from BaseFileSystem.readFileSync
- Defined in src/filesystem.ts:568

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[]>
Inherited from BaseFileSystem.readdir
- Defined in src/filesystem.ts:476

readdirSync

readdirSync(p, cred): string[]
Synchronous readdir. Reads the contents of a directory.
Parameters
- p: string
- cred: Cred
Returns string[]
Inherited from BaseFileSystem.readdirSync
- Defined in src/filesystem.ts:479

readlink

readlink(p, cred): Promise<string>
Asynchronous readlink.
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from BaseFileSystem.readlink
- Defined in src/filesystem.ts:660

readlinkSync

readlinkSync(p, cred): string
Synchronous readlink.
Parameters
- p: string
- cred: Cred
Returns string
Inherited from BaseFileSystem.readlinkSync
- Defined in src/filesystem.ts:663

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>
Inherited from BaseFileSystem.realpath
- Defined in src/filesystem.ts:498

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
Inherited from BaseFileSystem.realpathSync
- Defined in src/filesystem.ts:517

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>
Inherited from BaseFileSystem.rename
- Defined in src/filesystem.ts:387

renameSync

renameSync(oldPath, newPath, cred): void
Synchronous rename.
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.renameSync
- Defined in src/filesystem.ts:390

rmdir

rmdir(p, cred): Promise<void>
Asynchronous rmdir.
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.rmdir
- Defined in src/filesystem.ts:464

rmdirSync

rmdirSync(p, cred): void
Synchronous rmdir.
Parameters
- p: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.rmdirSync
- Defined in src/filesystem.ts:467

stat

stat(p, cred): Promise<Stats>
Asynchronous stat.
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Inherited from BaseFileSystem.stat
- Defined in src/filesystem.ts:393

statSync

statSync(p, cred): Stats
Synchronous stat.
Parameters
- p: string
- cred: Cred
Returns Stats
Inherited from BaseFileSystem.statSync
- Defined in src/filesystem.ts:396

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>
Inherited from BaseFileSystem.symlink
- Defined in src/filesystem.ts:654

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
Inherited from BaseFileSystem.symlinkSync
- Defined in src/filesystem.ts:657

truncate

truncate(p, len, cred): Promise<void>
Asynchronous truncate.
Parameters
- p: string
- len: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.truncate
- Defined in src/filesystem.ts:537

truncateSync

truncateSync(p, len, cred): void
Synchronous truncate.
Parameters
- p: string
- len: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.truncateSync
- Defined in src/filesystem.ts:545

unlink

unlink(p, cred): Promise<void>
Asynchronous unlink.
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.unlink
- Defined in src/filesystem.ts:458

unlinkSync

unlinkSync(p, cred): void
Synchronous unlink.
Parameters
- p: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.unlinkSync
- Defined in src/filesystem.ts:461

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>
Inherited from BaseFileSystem.utimes
- Defined in src/filesystem.ts:642

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
Inherited from BaseFileSystem.utimesSync
- Defined in src/filesystem.ts:645

whenReady

whenReady(): Promise<FolderAdapter>
Returns Promise<FolderAdapter>
Inherited from BaseFileSystem.whenReady
- Defined in src/filesystem.ts:322

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>
Inherited from BaseFileSystem.writeFile
- Defined in src/filesystem.ts:582

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
Inherited from BaseFileSystem.writeFileSync
- Defined in src/filesystem.ts:595

`Static` isAvailable

isAvailable(): boolean
Returns boolean
- Defined in src/backends/FolderAdapter.ts:53

Class FolderAdapter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: FolderAdapter.Options

Returns FolderAdapter

Properties

_folder

Protected _ready

_wrapped

Static Create

Static Readonly Name

Accessors

metadata

Returns { freeSpace: number; name: string; readonly: boolean; supportsLinks: boolean; supportsProperties: boolean; synchronous: boolean; totalSpace: number; }

freeSpace: number

name: string

readonly: boolean

supportsLinks: boolean

supportsProperties: boolean

synchronous: boolean

totalSpace: number

Methods

Private _initialize

Returns Promise<FolderAdapter>

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

`Protected` _ready

`Static` Create

`Static` `Readonly` Name

Returns {
freeSpace: number;
name: string;
readonly: boolean;
supportsLinks: boolean;
supportsProperties: boolean;
synchronous: boolean;
totalSpace: number;
}

`Private` _initialize