Class Dashboard

Dashboard implementation that consumes SwarmObserver data.

Implements

IDashboard

Index

Constructors

Methods

getSnapshot render getConfig updateConfig subscribe notifySubscribers

Constructors

constructor

new Dashboard(
observer: IInteractionObserver,
config?: Partial<DashboardConfig>,
): Dashboard
Parameters
- observer: IInteractionObserver
- Optionalconfig: Partial<DashboardConfig>
Returns Dashboard
- Defined in packages/nexus-agents/src/observability/dashboard.ts:68

Methods

getSnapshot

getSnapshot(options?: DashboardUpdateOptions): DashboardSnapshot
Get current dashboard snapshot.
Parameters
- Optionaloptions: DashboardUpdateOptions
Returns DashboardSnapshot
Implementation of IDashboard.getSnapshot
- Defined in packages/nexus-agents/src/observability/dashboard.ts:74

render

render(options?: DashboardUpdateOptions): string
Render dashboard to string in configured format.
Parameters
- Optionaloptions: DashboardUpdateOptions
Returns string
Implementation of IDashboard.render
- Defined in packages/nexus-agents/src/observability/dashboard.ts:93

getConfig

getConfig(): DashboardConfig
Get dashboard configuration.

Returns DashboardConfig
Implementation of IDashboard.getConfig
- Defined in packages/nexus-agents/src/observability/dashboard.ts:98

updateConfig

updateConfig(config: Partial<DashboardConfig>): void
Update dashboard configuration.
Parameters
- config: Partial<DashboardConfig>
Returns void
Implementation of IDashboard.updateConfig
- Defined in packages/nexus-agents/src/observability/dashboard.ts:102

subscribe(callback: (snapshot: DashboardSnapshot) => void): () => void
Subscribe to dashboard updates.
Parameters
- callback: (snapshot: DashboardSnapshot) => void
Returns () => void
Implementation of IDashboard.subscribe
- Defined in packages/nexus-agents/src/observability/dashboard.ts:107

notifySubscribers

notifySubscribers(): void
Notify all subscribers of an update.

Returns void
- Defined in packages/nexus-agents/src/observability/dashboard.ts:117