Interface BackendStopwatch

A service that exposes the back-end's Stopwatch to clients via the remote API. If you do not need this service then bind or re-bind the NullBackendStopwatch implementation to this service interface.

interface BackendStopwatch {
    start(name: string, options?: MeasurementOptions): Promise<number>;
    stop(
        measurement: number,
        message: string,
        messageArgs: any[],
    ): Promise<void>;
}

Implemented by

NullBackendStopwatch

Index

Methods

start stop

Methods

start

start(name: string, options?: MeasurementOptions): Promise<number>
Create a Measurement that will compute the time that elapsed on the back-end when logged.
Parameters
- name: string
  the measurement name
- Optionaloptions: MeasurementOptions
  optional configuration of the new measurement
Returns Promise<number>
a token identifying an unique self-timing measurement relative to the back-end's timeline
- Defined in packages/core/src/common/performance/measurement-protocol.ts:47

stop

stop(measurement: number, message: string, messageArgs: any[]): Promise<void>
Stop a measurement previously started and log in the back-end a measurement of its duration relative to the back-end's timeline.
Parameters
- measurement: number
  token identifying a measurement previously started
- message: string
  a message to log
- messageArgs: any[]
  optional arguments to the message
Returns Promise<void>
- Defined in packages/core/src/common/performance/measurement-protocol.ts:57

Interface BackendStopwatch

Implemented by

Index

Methods

Methods

start

Parameters

Returns Promise<number>

stop

Parameters

Returns Promise<void>

Settings

On This Page