Class NDNFileSystem

ndn6-file-server client wrapped as ZenFS backend.

Remarks

This backend only supports async operations.

Hierarchy

AsyncMixin<this> & ReadonlyMixin & FileSystem<this>
- NDNFileSystem

Index

Constructors

Methods

read readdir stat

Constructors

constructor

new NDNFileSystem(opts: NDNFileSystem.Options): NDNFileSystem
Parameters
- opts: NDNFileSystem.Options
Returns NDNFileSystem
Overrides Async(Readonly(FileSystem)).constructor
- Defined in fileserver/src/zenfs.ts:16

Methods

read

read(
    path: string,
    buffer: Uint8Array,
    offset: number,
    end: number,
): Promise<void>
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
- end: number
  The position in the file to stop reading
Returns Promise<void>
Overrides Async(Readonly(FileSystem)).read
- Defined in fileserver/src/zenfs.ts:66

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides Async(Readonly(FileSystem)).readdir
- Defined in fileserver/src/zenfs.ts:57

stat

stat(path: string): Promise<InodeLike>
Parameters
- path: string
Returns Promise<InodeLike>
Overrides Async(Readonly(FileSystem)).stat
- Defined in fileserver/src/zenfs.ts:45