Profiler Class
Profiles functions in JavaScript.
Item Index
Methods
- clear static
- getAverage static
- getCallCount static
- getFullReport static
- getFunctionReport static
- getMax static
- getMin static
- getOriginal static
- getReport static
- instrument static
- pause static
- registerConstructor static
- registerFunction static
- registerObject static
- start static
- stop static
- unregisterFunction static
- unregisterFunction static
- unregisterObject static
Methods
clear
-
name
Removes all report data from the profiler.
Parameters:
-
nameString(Optional) The name of the report to clear. If omitted, then all report data is cleared.
Returns:
getAverage
-
name
Returns the average amount of time (in milliseconds) that the function with the given name takes to execute.
Parameters:
-
nameStringThe name of the function whose data should be returned. If an object type method, it should be 'constructor.prototype.methodName'; a normal object method would just be 'object.methodName'.
Returns:
getCallCount
-
name
Returns the number of times that the given function has been called.
Parameters:
-
nameStringThe name of the function whose data should be returned.
Returns:
getFullReport
()
Object
static
Returns an object containing profiling data for all of the functions that were profiled. The object has an entry for each function and returns all information (min, max, average, calls, etc.) for each function.
Returns:
getFunctionReport
()
Object
deprecated
static
Returns an object containing profiling data for a single function. The object has an entry for min, max, avg, calls, and points).
Returns:
getMax
-
name
Returns the maximum amount of time (in milliseconds) that the function with the given name takes to execute.
Parameters:
-
nameStringThe name of the function whose data should be returned. If an object type method, it should be 'constructor.prototype.methodName'; a normal object method would just be 'object.methodName'.
Returns:
getMin
-
name
Returns the minimum amount of time (in milliseconds) that the function with the given name takes to execute.
Parameters:
-
nameStringThe name of the function whose data should be returned. If an object type method, it should be 'constructor.prototype.methodName'; a normal object method would just be 'object.methodName'.
Returns:
getOriginal
-
name
Returns the uninstrumented version of a function/object.
Parameters:
-
nameStringThe name of the function/object to retrieve.
getReport
()
Object
static
Returns an object containing profiling data for a single function. The object has an entry for min, max, avg, calls, and points).
Returns:
instrument
-
name -
method
Instruments a method to have profiling calls.
Parameters:
Returns:
pause
-
name
Pauses profiling information for a given name.
Parameters:
-
nameStringThe name of the data point.
Returns:
registerConstructor
-
name -
owner
Sets up a constructor for profiling, including all properties and methods on the prototype.
Parameters:
Returns:
registerFunction
-
name -
owner -
registerPrototype
Sets up a function for profiling. It essentially overwrites the function with one that has instrumentation data. This method also creates an entry for the function in the profile report. The original function is stored on the container object.
Parameters:
-
nameStringThe full name of the function including namespacing. This is the name of the function that is stored in the report.
-
ownerObject(Optional) The object that owns the function. If the function isn't global then this argument is required. This could be the namespace that the function belongs to or the object on which it's a method.
-
registerPrototypeBoolean(Optional) Indicates that the prototype should also be instrumented. Setting to true has the same effect as calling registerConstructor().
Returns:
registerObject
-
name -
owner -
recurse
Sets up an object for profiling. It takes the object and looks for functions. When a function is found, registerMethod() is called on it. If set to recrusive mode, it will also setup objects found inside of this object for profiling, using the same methodology.
Parameters:
Returns:
start
-
name
Start profiling information for a given name. The name cannot be the name of a registered function or object. This is used to start timing for a particular block of code rather than instrumenting the entire function.
Parameters:
-
nameStringThe name of the data point.
Returns:
stop
-
name
Stops profiling information for a given name.
Parameters:
-
nameStringThe name of the data point.
Returns:
unregisterFunction
-
name
Removes a constructor function from profiling. Reverses the registerConstructor() method.
Parameters:
-
nameStringThe full name of the function including namespacing. This is the name of the function that is stored in the report.
Returns:
unregisterFunction
-
name
Removes function from profiling. Reverses the registerFunction() method.
Parameters:
-
nameStringThe full name of the function including namespacing. This is the name of the function that is stored in the report.
Returns:
unregisterObject
-
name -
recurse
Unregisters an object for profiling. It takes the object and looks for functions. When a function is found, unregisterMethod() is called on it. If set to recrusive mode, it will also unregister objects found inside of this object, using the same methodology.