Classes
Dashboard
Defined in: dashboard.ts:60
Class to handle updating and formatting dashboard data
Constructors
new Dashboard()
new Dashboard(options): DashboardDefined in: dashboard.ts:67
Parameters
options
Returns
Properties
dashboardRoot
dashboardRoot: string[];Defined in: dashboard.ts:62
packageJson
packageJson: PackageJsonDefined in: dashboard.ts:61
publicDir
publicDir: stringDefined in: dashboard.ts:64
scurry
scurry: PathScurryDefined in: dashboard.ts:63
version
version: stringDefined in: dashboard.ts:65
Methods
format()
format(projectFolders): Promise<DashboardData>Defined in: dashboard.ts:109
Parameters
projectFolders
PathBase[]
Returns
Promise<DashboardData>
getProjectData()
getProjectData(folder): undefined | DashboardProjectDataDefined in: dashboard.ts:156
Parameters
folder
Returns
undefined | DashboardProjectData
update()
update(): Promise<boolean>Defined in: dashboard.ts:81
Returns
Promise<boolean>
Type Aliases
DashboardData
type DashboardData = objectDefined in: dashboard.ts:49
Type declaration
buildVersion
buildVersion: stringcwd
cwd: stringdashboardProjectLocations
dashboardProjectLocations: DashboardLocation[];defaultAuthor
defaultAuthor: stringprojects
projects: DashboardProjectData[];DashboardLocation
type DashboardLocation = objectDefined in: dashboard.ts:44
Type declaration
path
path: stringreadablePath
readablePath: stringDashboardOptions
type DashboardOptions = objectDefined in: dashboard.ts:37
Type declaration
dashboard-root
dashboard-root: string[];packageJson
packageJson: PackageJsonpublicDir
publicDir: stringscurry
scurry: PathScurryDashboardProjectData
type DashboardProjectData = objectDefined in: dashboard.ts:28
Type declaration
manifest
manifest: Manifestmtime?
optional mtime: number;name
name: stringpath
path: stringreadablePath
readablePath: stringtools
tools: ProjectTools[];Variables
version
version: stringDefined in: dashboard.ts:21