Class LogPerformanceService

Service for sending log performance metrics

Hierarchy (View Summary)

MessageInvokerService
- LogPerformanceService

Index

Constructors

constructor

new LogPerformanceService(
eventTarget: EventTargetOrCommChannel,
): LogPerformanceService
Create a service for the specific worker
Parameters
- eventTarget: EventTargetOrCommChannel
Returns LogPerformanceService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-performance.service.d.ts:12

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

logPerformanceMetrics

logPerformanceMetrics(markName: string): Promise<void>
Sends a basic log performance metric where duration, start and end names are the same.
Parameters
- markName: string
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-performance.service.d.ts:18

logPerformanceMetricsExtended

logPerformanceMetricsExtended(
    durationName: string,
    startName: string,
    endName: string,
): Promise<void>
Sends a extended log performance metric where duration, start and end names can be specified individually.
Parameters
- durationName: string
  The duration name
- startName: string
  The start name
- endName: string
  The end name
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-performance.service.d.ts:26

postAndAwait

postAndAwait<T>(type: string, data?: any): Promise<T>
returns a reply promise to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:192

postAndObserve

postAndObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:199

request

request<T>(type: string, data?: any): Promise<T>
returns a reply promise for the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.request
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:178

requestObserve

requestObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.requestObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:185

Class LogPerformanceService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LogPerformanceService

Properties

communicationChannel

`Readonly`eventTarget

Methods

logPerformanceMetrics

Parameters

Returns Promise<void>

logPerformanceMetricsExtended

Parameters

Returns Promise<void>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

Settings

On This Page

Class LogPerformanceService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LogPerformanceService

Properties

communicationChannel

ReadonlyeventTarget

Methods

logPerformanceMetrics

Parameters

Returns Promise<void>

logPerformanceMetricsExtended

Parameters

Returns Promise<void>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

Settings

On This Page

`Readonly`eventTarget