Class ParentItem

Hierarchy

ItemBase
- ParentItem
  - Folder
  - Root

Index

Constructors

constructor

Properties

Accessors

count
size

Methods

Constructors

constructor

new ParentItem(item: Partial<ParentItem>): ParentItem

- Defined in packages/core/src/Item.ts:37
Parameters
- item: Partial<ParentItem>
Returns ParentItem

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: FolderType

The type of item, root or a folder.

Accessors

count

get count(): number

- Defined in packages/core/src/Item.ts:85
Returns number

size

get size(): number

- Defined in packages/core/src/Item.ts:75
Returns number

Methods

commit

commit(): Promise<void>

- Defined in packages/core/src/Item.ts:89
Returns Promise<void>

delete

delete(name: string): boolean

- Defined in packages/core/src/Item.ts:71
Parameters
- name: string
Returns boolean

get

get(name: string): Item

- Defined in packages/core/src/Item.ts:61
Parameters
- name: string
Returns Item

list

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

- Defined in packages/core/src/Item.ts:52
Returns string[]
- Defined in packages/core/src/Item.ts:53
Parameters
- long: true
Returns Item[]
- Defined in packages/core/src/Item.ts:54
Parameters
- long: boolean
Returns string[] | Item[]

set

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

- Defined in packages/core/src/Item.ts:65
Parameters
- name: string
- item: Item
Returns void

Generated using TypeDoc