Profiler: Profiler() constructor
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The Profiler()
constructor creates a new Profiler
object.
Once created, the new profiler will start collecting samples.
Syntax
new Profiler(options)
Parameters
options
-
Options for this profiler. This is an object containing the following properties:
maxBufferSize
-
A number indicating the maximum number of samples to take. Once this number is reached, the browser will fire the
samplebufferfull
event at the profiler, and no more samples will be recorded. sampleInterval
-
The time interval between samples, in milliseconds.
Exceptions
RangeError
DOMException
-
Thrown if the
sampleInterval
option is less than zero. NotAllowedError
DOMException
-
Thrown if the document was not served with a document policy that included the
"js-profiling"
configuration point.
Examples
This example creates a profiler which will take up to 1000 samples, sampling every 10 milliseconds.
const profiler = new Profiler({ sampleInterval: 10, maxBufferSize: 1000 });
Specifications
Specification |
---|
JS Self-Profiling API # dom-profiler-constructor |