Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Root

A special item; represents the top-level of the file system.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Root(adapter: Adapter): Root

Properties

adapter

adapter: Adapter

The file system adapter instance to use.

committed

committed: boolean

The status of the commit.

contents

contents: Map<string, Item>

The children of the folder.

name

name: string

The name of the item.

Optional parent

parent: ParentItem

The parent of the item.

path

path: string

The absolute path to the item.

type

type: "root"

The type of item, a root folder.

Accessors

count

  • get count(): number

size

  • get size(): number

Methods

commit

  • commit(): Promise<void>

delete

  • delete(name: string): boolean

get

  • get(name: string): Item

list

  • list(): string[]
  • list(long: true): Item[]
  • list(long: boolean): string[] | Item[]

set

  • set(name: string, item: Item): void

Generated using TypeDoc