Class VirtualFilesystem

This class represents a tree of source code rooted at a single script. Each method returns null if the target was not the correct file type, or did not exist

Hierarchy

Filesystem
- VirtualFilesystem

Index

Constructors

Properties

Methods

tryList tryRead tryResolve

Constructors

constructor

new VirtualFilesystem(source: {
[path: string]: string;
}): VirtualFilesystem
Parameters
- source: {
  [path: string]: string;
  }
  - [path: string]: string
Returns VirtualFilesystem
Overrides Filesystem.constructor
- Defined in packages/sqrl/src/api/filesystem.ts:34

Properties

`Private` source

source: {
[path: string]: string;
}

Type declaration

[path: string]: string

Methods

tryList

tryList(folder: string): string[]
Return a directory listing for a given path, or null if the folder does not exist.
Parameters
- folder: string
Returns string[]
Overrides Filesystem.tryList
- Defined in packages/sqrl/src/api/filesystem.ts:42

tryRead

tryRead(path: string): Buffer
Read a file at the given path, returns the file contents as a binary buffer if the file exists, otherwise null.
Parameters
- path: string
Returns Buffer
Overrides Filesystem.tryRead
- Defined in packages/sqrl/src/api/filesystem.ts:51

tryResolve

tryResolve(path: string): string
Parameters
- path: string
Returns string
- Defined in packages/sqrl/src/api/filesystem.ts:57

Generated using TypeDoc