This interface identifies the details of an internal performance event - it does not represent an outgoing reported event

Hierarchy

  • IPerfEvent

Implemented by

Properties

childEvts?: IPerfEvent[]

The child perf events that are contained within the total time of this event.

complete: (() => void)

Type declaration

    • (): void
    • Mark this event as completed, calculating the total execution time.

      Returns void

exTime?: number

Identifies the exclusive time spent in for this event (not including child events), this will be undefined until the event is completed.

getCtx?: ((key) => any)

Type declaration

    • (key): any
    • Get the names additional context associated with this perf event

      Parameters

      • key: string

      Returns any

isAsync: boolean

Is this occurring from an asynchronous event

isChildEvt: (() => boolean)

Type declaration

    • (): boolean
    • Identifies whether this event is a child event of a parent

      Returns boolean

name: string

The name of the performance event

parent?: IPerfEvent

The Parent event that was started before this event was created

payload: any

The payload (contents) of the perfEvent, may be null or only set after the event has completed depending on the runtime environment.

setCtx?: ((key, value) => void)

Type declaration

    • (key, value): void
    • Set the named additional context to be associated with this perf event, this will replace any existing value

      Parameters

      • key: string
      • value: any

      Returns void

start: number

The start time of the performance event

time?: number

Identifies the total inclusive time spent for this event, including the time spent for child events, this will be undefined until the event is completed

Generated using TypeDoc