Class HTTPRequest

A simple filesystem backed by HTTP downloads. You must create a directory listing using the make_http_index tool provided by BrowserFS.

If you install BrowserFS globally with npm i -g browserfs, you can generate a listing by running make_http_index in your terminal in the directory you would like to index:

make_http_index > index.json

Listings objects look like the following:

{
  "home": {
    "jvilk": {
      "someFile.txt": null,
      "someDir": {
        // Empty directory
      }
    }
  }
}

This example has the folder /home/jvilk with subfile someFile.txt and subfolder someDir.

Hierarchy

BaseFileSystem
- HTTPRequest

Constructors

constructor

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

Properties

`Private` _index

_index: FileIndex<{}>

Type declaration

`Protected` _ready

_ready: Promise<HTTPRequest>

`Readonly` prefixUrl

prefixUrl: string

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "HTTPRequest" = 'HTTPRequest'

Accessors

metadata

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

Methods

`Private` _getHTTPPath

_getHTTPPath(filePath): string
Parameters
- filePath: string
Returns string
- Defined in src/backends/HTTPRequest.ts:221

`Private` _requestFile

_requestFile(p, type): Promise<Uint8Array>
Asynchronously download the given file.
Parameters
- p: string
- type: "buffer"
Returns Promise<Uint8Array>
- Defined in src/backends/HTTPRequest.ts:231
_requestFile(p, type): Promise<any>
Parameters
- p: string
- type: "json"
Returns Promise<any>
- Defined in src/backends/HTTPRequest.ts:232
_requestFile(p, type): Promise<any>
Parameters
- p: string
- type: "buffer" | "json"
Returns Promise<any>
- Defined in src/backends/HTTPRequest.ts:233

`Private` _requestFileSize

_requestFileSize(path): Promise<number>
Only requests the HEAD content, for the file size.
Parameters
- path: string
Returns Promise<number>
- Defined in src/backends/HTTPRequest.ts:241

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<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

empty

empty(): void
Returns void
- Defined in src/backends/HTTPRequest.ts:113

exists

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

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>
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: number
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.mkdir
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:311

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(path, flags, mode, cred): Promise<NoSyncFile<HTTPRequest>>
Parameters
- path: string
- flags: FileFlag
- mode: number
- cred: Cred
Returns Promise<NoSyncFile<HTTPRequest>>
Overrides BaseFileSystem.open
- Defined in src/backends/HTTPRequest.ts:161

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

preloadFile

preloadFile(path, buffer): void
Special HTTPFS function: Preload the given file into the index.
Parameters
- path: string
- buffer: Uint8Array
Returns void
- Defined in src/backends/HTTPRequest.ts:124

readFile

readFile(fname, flag, cred): Promise<Uint8Array>
We have the entire file as a buffer; optimize readFile.
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Promise<Uint8Array>
Overrides BaseFileSystem.readFile
- Defined in src/backends/HTTPRequest.ts:211

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/HTTPRequest.ts:204

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

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

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/HTTPRequest.ts:138

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(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from BaseFileSystem.unlink
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:307

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

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/HTTPRequest.ts:79

Class HTTPRequest

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: HTTPRequest.Options

Returns HTTPRequest

Properties

Private _index

Type declaration

Protected _ready

Readonly prefixUrl

Static Create

Static Readonly Name

Accessors

metadata

Returns FileSystemMetadata

Methods

Private _getHTTPPath

Parameters

filePath: string

Returns string

Private _requestFile

Parameters

p: string

type: "buffer"

Returns Promise<Uint8Array>

Parameters

p: string

type: "json"

Returns Promise<any>

Parameters

p: string

type: "buffer" | "json"

Returns Promise<any>

Private _requestFileSize

Parameters

path: string

Returns Promise<number>

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

`Private` _index

`Protected` _ready

`Readonly` prefixUrl

`Static` Create

`Static` `Readonly` Name

`Private` _getHTTPPath

`Private` _requestFile

`Private` _requestFileSize