spectacular-dashboard / SpecsTreeProvider / SpecsTreeProvider

Class: SpecsTreeProvider

SpecsTreeProvider.SpecsTreeProvider

Implements

• TreeDataProvider<TreeItem>

Table of contents

Constructors

• constructor

Properties

• _onDidChangeTreeData
• itemCache
• onDidChangeTreeData
• specsRoot
• workspaceRoot

Methods

• _containsMarkdown
• _findItemRecursive
• _findSpecsRoot
• _isMarkdownFile
• _normalizePath
• findTreeItem
• getChildren
• getParent
• getSpecsRoot
• getTreeItem
• refresh

Constructors

constructor

• new SpecsTreeProvider(): SpecsTreeProvider

Returns

SpecsTreeProvider

Defined in

src/SpecsTreeProvider.ts:14

Properties

_onDidChangeTreeData

• Private _onDidChangeTreeData: EventEmitter<undefined | null | void | TreeItem>

Defined in

src/SpecsTreeProvider.ts:7

---

itemCache

• Private itemCache: Map<string, SpecsTreeItem>

Defined in

src/SpecsTreeProvider.ts:12

---

onDidChangeTreeData

• Readonly onDidChangeTreeData: Event<undefined | null | void | TreeItem>

Implementation of

vscode.TreeDataProvider.onDidChangeTreeData

Defined in

src/SpecsTreeProvider.ts:8

---

specsRoot

• Private specsRoot: undefined | Uri

Defined in

src/SpecsTreeProvider.ts:11

---

workspaceRoot

• Private workspaceRoot: undefined | string

Defined in

src/SpecsTreeProvider.ts:10

Methods

_containsMarkdown

▸ _containsMarkdown(folderUri): Promise<boolean>

Parameters

Name	Type
folderUri	Uri

Returns

Promise<boolean>

Defined in

src/SpecsTreeProvider.ts:185

---

_findItemRecursive

▸ _findItemRecursive(normalizedFilePath, parent?): Promise<undefined | SpecsTreeItem>

Parameters

Name	Type
normalizedFilePath	string
parent?	SpecsTreeItem

Returns

Promise<undefined | SpecsTreeItem>

Defined in

src/SpecsTreeProvider.ts:215

---

_findSpecsRoot

▸ _findSpecsRoot(): Promise<void>

Returns

Promise<void>

Defined in

src/SpecsTreeProvider.ts:19

---

_isMarkdownFile

▸ _isMarkdownFile(filename): boolean

Parameters

Name	Type
filename	string

Returns

boolean

Defined in

src/SpecsTreeProvider.ts:180

---

_normalizePath

▸ _normalizePath(p): string

Parameters

Name	Type
p	string

Returns

string

Defined in

src/SpecsTreeProvider.ts:60

---

findTreeItem

▸ findTreeItem(filePath): Promise<undefined | SpecsTreeItem>

Parameters

Name	Type
filePath	string

Returns

Promise<undefined | SpecsTreeItem>

Defined in

src/SpecsTreeProvider.ts:210

---

getChildren

▸ getChildren(element?): Promise<TreeItem[]>

Parameters

Name	Type
element?	TreeItem

Returns

Promise<TreeItem[]>

Implementation of

vscode.TreeDataProvider.getChildren

Defined in

src/SpecsTreeProvider.ts:84

---

getParent

▸ getParent(element): undefined | TreeItem

Parameters

Name	Type
element	TreeItem

Returns

undefined | TreeItem

Implementation of

vscode.TreeDataProvider.getParent

Defined in

src/SpecsTreeProvider.ts:65

---

getSpecsRoot

▸ getSpecsRoot(): undefined | Uri

Returns

undefined | Uri

Defined in

src/SpecsTreeProvider.ts:205

---

getTreeItem

▸ getTreeItem(element): TreeItem

Parameters

Name	Type
element	TreeItem

Returns

TreeItem

Implementation of

vscode.TreeDataProvider.getTreeItem

Defined in

src/SpecsTreeProvider.ts:55

---

refresh

▸ refresh(): void

Returns

void

Defined in

src/SpecsTreeProvider.ts:49