Properties Jump to heading
eventLoopUtilization is similar to CPU utilization except that it is calculated using high precision wall-clock time. It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait). No other CPU idle time is taken into consideration.
This property is an extension by Node.js. It is not available in Web browsers.
An instance of the PerformanceNodeTiming
class that provides performance metrics for specific Node.js operational milestones.
Jump to headingtimeOrigin: number
The timeOrigin
specifies the high resolution millisecond timestamp
at which the current node
process began, measured in Unix time.
Methods Jump to heading
Jump to headingclearMarks(name?: string): void
If name
is not provided, removes all PerformanceMark
objects from the Performance Timeline.
If name
is provided, removes only the named mark.
Jump to headingclearMeasures(name?: string): void
If name
is not provided, removes all PerformanceMeasure
objects from the Performance Timeline.
If name
is provided, removes only the named measure.
Jump to headingclearResourceTimings(name?: string): void
If name
is not provided, removes all PerformanceResourceTiming
objects from the Resource Timeline.
If name
is provided, removes only the named resource.
Returns a list of PerformanceEntry
objects in chronological order with respect to performanceEntry.startTime
.
If you are only interested in performance entries of certain types or that have certain names, see
performance.getEntriesByType()
and performance.getEntriesByName()
.
Jump to headinggetEntriesByName(name: string,type?: EntryType,): PerformanceEntry[]
Returns a list of PerformanceEntry
objects in chronological order with respect to performanceEntry.startTime
whose performanceEntry.name
is equal to name
, and optionally, whose performanceEntry.entryType
is equal to type
.
Returns a list of PerformanceEntry
objects in chronological order with respect to performanceEntry.startTime
whose performanceEntry.entryType
is equal to type
.
Jump to headingmark(name: string,options?: MarkOptions,): PerformanceMark
Creates a new PerformanceMark
entry in the Performance Timeline.
A PerformanceMark
is a subclass of PerformanceEntry
whose performanceEntry.entryType
is always 'mark'
,
and whose performanceEntry.duration
is always 0
.
Performance marks are used to mark specific significant moments in the Performance Timeline.
The created PerformanceMark
entry is put in the global Performance Timeline and can be queried with
performance.getEntries
, performance.getEntriesByName
, and performance.getEntriesByType
. When the observation is
performed, the entries should be cleared from the global Performance Timeline manually with performance.clearMarks
.
Jump to headingmarkResourceTiming(timingInfo: object,requestedUrl: string,initiatorType: string,global: object,cacheMode: "" | "local",bodyInfo: object,responseStatus: number,deliveryType?: string,): PerformanceResourceTiming
Creates a new PerformanceResourceTiming
entry in the Resource Timeline.
A PerformanceResourceTiming
is a subclass of PerformanceEntry
whose performanceEntry.entryType
is always 'resource'
.
Performance resources are used to mark moments in the Resource Timeline.
Jump to headingmeasure(name: string,startMark?: string,endMark?: string,): PerformanceMeasure
Creates a new PerformanceMeasure entry in the Performance Timeline. A PerformanceMeasure is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'measure', and whose performanceEntry.duration measures the number of milliseconds elapsed since startMark and endMark.
The startMark argument may identify any existing PerformanceMark in the the Performance Timeline, or may identify any of the timestamp properties provided by the PerformanceNodeTiming class. If the named startMark does not exist, then startMark is set to timeOrigin by default.
The endMark argument must identify any existing PerformanceMark in the the Performance Timeline or any of the timestamp properties provided by the PerformanceNodeTiming class. If the named endMark does not exist, an error will be thrown.
Jump to headingmeasure(name: string,options: MeasureOptions,): PerformanceMeasure
Jump to headingnow(): number
Returns the current high resolution millisecond timestamp, where 0 represents the start of the current node
process.
Jump to headingsetResourceTimingBufferSize(maxSize: number): void
Sets the global performance resource timing buffer size to the specified number of "resource" type performance entry objects.
By default the max buffer size is set to 250.
Jump to headingtimerify<T extends (...params: any[]) => any>(fn: T,options?: TimerifyOptions,): T
This property is an extension by Node.js. It is not available in Web browsers.
Wraps a function within a new function that measures the running time of the wrapped function.
A PerformanceObserver
must be subscribed to the 'function'
event type in order for the timing details to be accessed.
import {
performance,
PerformanceObserver,
} from 'node:perf_hooks';
function someFunction() {
console.log('hello world');
}
const wrapped = performance.timerify(someFunction);
const obs = new PerformanceObserver((list) => {
console.log(list.getEntries()[0].duration);
performance.clearMarks();
performance.clearMeasures();
obs.disconnect();
});
obs.observe({ entryTypes: ['function'] });
// A performance timeline entry will be created
wrapped();
If the wrapped function returns a promise, a finally handler will be attached to the promise and the duration will be reported once the finally handler is invoked.
Jump to headingtoJSON(): any
An object which is JSON representation of the performance object. It is similar to
window.performance.toJSON
in browsers.