Interface Performance

Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API.

interface Performance {
    eventCounts: EventCounts;
    navigation: PerformanceNavigation;
    onresourcetimingbufferfull: ((this, ev) => any);
    timeOrigin: number;
    timing: PerformanceTiming;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    clearMarks(markName?): void;
    clearMeasures(measureName?): void;
    clearResourceTimings(): void;
    dispatchEvent(event): boolean;
    getEntries(): PerformanceEntryList;
    getEntriesByName(name, type?): PerformanceEntryList;
    getEntriesByType(type): PerformanceEntryList;
    mark(markName, markOptions?): PerformanceMark;
    measure(measureName, startOrMeasureOptions?, endMark?): PerformanceMeasure;
    now(): number;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    setResourceTimingBufferSize(maxSize): void;
    toJSON(): any;
}

Hierarchy

  • EventTarget
    • Performance

Properties

eventCounts navigation onresourcetimingbufferfull timeOrigin timing

Methods

addEventListener clearMarks clearMeasures clearResourceTimings dispatchEvent getEntries getEntriesByName getEntriesByType mark measure now removeEventListener setResourceTimingBufferSize toJSON

Properties

Readonly eventCounts

eventCounts: EventCounts

Readonly navigation

navigation: PerformanceNavigation

Deprecated

onresourcetimingbufferfull

onresourcetimingbufferfull: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

Readonly timeOrigin

timeOrigin: number

Readonly timing

timing: PerformanceTiming

Deprecated

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "resourcetimingbufferfull"

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    Returns void

clearMarks

  • clearMarks(markName?): void

  • Parameters

    • Optional markName: string

    Returns void

clearMeasures

  • clearMeasures(measureName?): void

  • Parameters

    • Optional measureName: string

    Returns void

clearResourceTimings

  • clearResourceTimings(): void

  • Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

getEntries

getEntriesByName

  • getEntriesByName(name, type?): PerformanceEntryList

  • Parameters

    • name: string
    • Optional type: string

    Returns PerformanceEntryList

getEntriesByType

mark

measure

  • measure(measureName, startOrMeasureOptions?, endMark?): PerformanceMeasure

  • Parameters

    Returns PerformanceMeasure

now

  • now(): number

  • Returns number

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "resourcetimingbufferfull"

    Parameters

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    Returns void

setResourceTimingBufferSize

  • setResourceTimingBufferSize(maxSize): void

  • Parameters

    • maxSize: number

    Returns void

toJSON

  • toJSON(): any

  • Returns any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc