Interface IPerfEvent

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

interface IPerfEvent {
    childEvts?: IPerfEvent[];
    complete: (() => void);
    exTime?: number;
    getCtx?: ((key: string) => any);
    isAsync: boolean;
    isChildEvt: (() => boolean);
    name: string;
    parent?: IPerfEvent;
    payload: any;
    setCtx?: ((key: string, value: any) => void);
    start: number;
    time?: number;
}

Implemented by

Properties

childEvts? complete exTime? getCtx? isAsync isChildEvt name parent? payload setCtx? start time?

Properties

OptionalchildEvts

childEvts?: IPerfEvent[]

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

complete

complete: (() => void)

Mark this event as completed, calculating the total execution time.

OptionalexTime

exTime?: number

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

OptionalgetCtx

getCtx?: ((key: string) => any)

Get the names additional context associated with this perf event

isAsync

isAsync: boolean

Is this occurring from an asynchronous event

isChildEvt

isChildEvt: (() => boolean)

Identifies whether this event is a child event of a parent

name

name: string

The name of the performance event

Optionalparent

parent?: IPerfEvent

The Parent event that was started before this event was created

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.

OptionalsetCtx

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

Set the named additional context to be associated with this perf event, this will replace any existing value

start

start: number

The start time of the performance event

Optionaltime

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

On This Page

Properties