@vltpkg/server/dashboard

Classes

Dashboard

Defined in: dashboard.ts:51

Class to handle updating and formatting dashboard data

Constructors

new Dashboard()

new Dashboard(options): Dashboard

Defined in: dashboard.ts:57

Parameters

options

DashboardOptions

Returns

Dashboard

Properties

dashboardRoot

dashboardRoot: string[];

Defined in: dashboard.ts:53

packageJson

packageJson: PackageJson

Defined in: dashboard.ts:52

publicDir

publicDir: string

Defined in: dashboard.ts:55

scurry

scurry: PathScurry

Defined in: dashboard.ts:54

Methods

format()

format(projectFolders): Promise<DashboardData>

Defined in: dashboard.ts:102

Parameters

projectFolders

PathBase[]

Returns

Promise<DashboardData>

getProjectData()

getProjectData(folder): undefined | DashboardProjectData

Defined in: dashboard.ts:148

Parameters

folder

PathBase

Returns

undefined | DashboardProjectData

update()

update(): Promise<boolean>

Defined in: dashboard.ts:79

Returns

Promise<boolean>

Type Aliases

DashboardData

type DashboardData = object

Defined in: dashboard.ts:41

Type declaration

cwd

cwd: string

dashboardProjectLocations

dashboardProjectLocations: DashboardLocation[];

defaultAuthor

defaultAuthor: string

projects

projects: DashboardProjectData[];

---

DashboardLocation

type DashboardLocation = object

Defined in: dashboard.ts:36

Type declaration

path

path: string

readablePath

readablePath: string

---

DashboardOptions

type DashboardOptions = object

Defined in: dashboard.ts:29

Type declaration

dashboard-root

dashboard-root: string[];

packageJson

packageJson: PackageJson

publicDir

publicDir: string

scurry

scurry: PathScurry

---

DashboardProjectData

type DashboardProjectData = object

Defined in: dashboard.ts:20

Type declaration

manifest

manifest: NormalizedManifest

mtime?

optional mtime: number;

name

name: string

path

path: string

readablePath

readablePath: string

tools

tools: ProjectTools[];