Class NoopAdapter

An adapter for No-Operation; essentially makes the VFS a memory-only instance.

Hierarchy

NoopAdapter

Implements

Adapter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NoopAdapter(): NoopAdapter

- Defined in packages/adapter-noop/index.ts:10
Creates an instance of noop adapter.

Returns NoopAdapter

Properties

handle

handle: "noop"

The handle for this adapter, basically an id. Should be something simple but descriptive, like 'node-fs' or 'blob'.

journal

journal: JournalEntry[]

Log useful messages to the journal about file operations.

Readonly root

root: string

The real root of this file system which will be committed to.

Methods

flush

flush(): Promise<void>

- Defined in packages/adapter-noop/index.ts:43
Flush the underlying file system to prepare for a commit.

Returns Promise<void>

link

link(from: string, to: string, type: LinkType): Promise<void>

- Defined in packages/adapter-noop/index.ts:37
Create a link in persistent storage.

Parameters
- from: string
- to: string
- type: LinkType
Returns Promise<void>

mkdir

mkdir(path: string): Promise<void>

- Defined in packages/adapter-noop/index.ts:34
Make a directory or directory tree in persistent storage.

Parameters
- path: string
Returns Promise<void>

remove

remove(path: string, type: ItemType): Promise<void>

- Defined in packages/adapter-noop/index.ts:40
Remove items from persistent storage.

Parameters
- path: string
- type: ItemType
Returns Promise<void>

snapshot

snapshot(): AsyncGenerator<[string, SnapshotEntry], any, unknown>

- Defined in packages/adapter-noop/index.ts:28
Snapshot of the underlying file system; an asynchronous iterable which returns an entry of path and data.

Returns AsyncGenerator<[string, SnapshotEntry], any, unknown>

The asynchronous iterable to get the snapshot.

write

write(path: string, contents?: Buffer): Promise<void>

- Defined in packages/adapter-noop/index.ts:31
Create a file or write the contents of a file to persistent storage.

Parameters
- path: string
- Optional contents: Buffer
Returns Promise<void>

Generated using TypeDoc