Class NDNFileSystem

ndn6-file-server client wrapped as BrowserFS backend.

Remarks

This backend only supports async operations.

Hierarchy

BaseFileSystem
- NDNFileSystem

Index

Constructors

Properties

Accessors

Methods

openFile readFile readdir stat isAvailable

Constructors

constructor

new NDNFileSystem(opts?): NDNFileSystem
Parameters
- opts: Partial<NDNFileSystem.Options> = {}
Returns NDNFileSystem
Overrides BaseFileSystem.constructor
- Defined in pkg/fileserver/src/browserfs.ts:41

Properties

`Static` `Readonly` Create

Create: ((...args) => void) = ...

Type declaration

- (...args): void
- Parameters
  - Rest ...args: [options: BackendOptions, cb: BFSCallback<FileSystem>]
  Returns void

`Static` `Readonly` Name

Name: "NDN" = "NDN"

Accessors

metadata

get metadata(): FileSystemMetadata
Returns FileSystemMetadata
Overrides BaseFileSystem.metadata
- Defined in pkg/fileserver/src/browserfs.ts:61

Methods

openFile

openFile(p, flag, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- cred: Cred
Returns Promise<File>
Overrides BaseFileSystem.openFile
- Defined in pkg/fileserver/src/browserfs.ts:93

readFile

readFile(p, flag, cred): Promise<Uint8Array>
Parameters
- p: string
- flag: FileFlag
- cred: Cred
Returns Promise<Uint8Array>
Overrides BaseFileSystem.readFile
- Defined in pkg/fileserver/src/browserfs.ts:102

readdir

readdir(p, cred): Promise<string[]>
Parameters
- p: string
- cred: Cred
Returns Promise<string[]>
Overrides BaseFileSystem.readdir
- Defined in pkg/fileserver/src/browserfs.ts:83

stat

stat(p, cred): Promise<Stats>
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Overrides BaseFileSystem.stat
- Defined in pkg/fileserver/src/browserfs.ts:77

`Static` isAvailable

isAvailable(): boolean
Returns boolean
- Defined in pkg/fileserver/src/browserfs.ts:37