Class PerfEvent

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

Hierarchy

  • PerfEvent

Implements

Constructors

constructor

Properties

ChildrenContextKey ParentContextKey complete exTime? getCtx? isAsync isChildEvt name payload setCtx? start time?

Constructors

constructor

  • Parameters

    • name: string
    • payloadDetails: (() => any)
        • (): any

        • Returns any

    • isAsync: boolean

    Returns PerfEvent

Properties

Static ChildrenContextKey

ChildrenContextKey: string

Static ParentContextKey

ParentContextKey: string

complete

complete: (() => void)

Type declaration

    • (): void

    • Returns void

Optional exTime

exTime?: number

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

Optional getCtx

getCtx?: ((key) => any)

Type declaration

    • (key): any

    • Parameters

      • key: string

      Returns any

isAsync

isAsync: boolean

Is this occurring from an asynchronous event

isChildEvt

isChildEvt: (() => boolean)

Type declaration

    • (): boolean

    • Identifies whether this event is a child event of a parent

      Returns boolean

name

name: string

The name of the event

payload

payload: any

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

Optional setCtx

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

Type declaration

    • (key, value): void

    • Parameters

      • key: string
      • value: any

      Returns void

start

start: number

The start time of the event in ms

Optional time

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc