Interface ReadonlyNetworkMetricsController

interface ReadonlyNetworkMetricsController {
    metrics: NetworkMetrics;
    getServiceMetrics(serviceId: Maybe<string>): ServiceMetrics;
    hasAnyListeners(): boolean;
    hasListeners(type: "metricsChange"): boolean;
    on<K extends "metricsChange">(
        type: K,
        handler: EventHandler<NetworkMetricsEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyEventHost<NetworkMetricsEventMap>
- ReadonlyNetworkMetricsController
  - NetworkMetricsController

Index

Properties

Methods

getServiceMetrics hasAnyListeners hasListeners on

Properties

`Readonly`metrics

metrics: NetworkMetrics

The current metrics state. The returned object is static at the time of request.

Methods

getServiceMetrics

getServiceMetrics(serviceId: Maybe<string>): ServiceMetrics
Returns metrics for the given service id. If the service id is nullish, or there is no history for the given service, empty service metrics will be returned.

The returned object is static at the time of request.
Parameters
- serviceId: Maybe<string>
Returns ServiceMetrics
- Defined in network/metrics/NetworkMetricsController.ts:38

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in event/EventHost.ts:44

hasListeners

hasListeners(type: "metricsChange"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "metricsChange"
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in event/EventHost.ts:49

on

on<K extends "metricsChange">(
    type: K,
    handler: EventHandler<NetworkMetricsEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "metricsChange"
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<NetworkMetricsEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in event/EventHost.ts:35