Surf-N-Perf

Class: SurfNPerf

SurfNPerf

new SurfNPerf()

surfnperf.js, line 67

Frontend Web Performance Data Gathering

Methods

staticSurfNPerf.SNPProto.clearMarks(eventKey)

surfnperf.js, line 209

Removes all user-set marks (or just the specified one) and their associated time values. Will not remove the loadEventEnd mark.

Name Type Description
eventKey String optional

removes all time values for the given eventKey

staticSurfNPerf.SNPProto.duration(startMark, endMark){Number}

surfnperf.js, line 309

Returns the duration between two marks

Name Type Description
startMark String

name of the first mark
endMark String optional

optional name of the second mark
Returns:
Type Description
Number duration between the two specified marks. If the endMark is not specified, returns the duration between the startMark and the current time

staticSurfNPerf.SNPProto.getFirstContentfulPaint(){integer}

surfnperf.js, line 445

Time to first contentful paint (browser-reported time for the render of any content from the DOM)

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getFirstPaint(){integer}

surfnperf.js, line 428

Time to first paint (browser-reported time for the first pixels to be rendered on the page)

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getFirstPaintFrame(){integer}

surfnperf.js, line 466

Time to first paint (Time calculated based on window.requestAnimationFrame() for the first pixels to be rendered on the page)

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getFullRequestLoadTime(){integer}

surfnperf.js, line 418

Total time for a page to load from the time the user initiates the access of the page to the firing of the onLoad event

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getHiddenTime(){integer}

surfnperf.js, line 506

Total time a page is not visible, as reported by the Page Visibility API

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getNetworkLatency(){integer}

surfnperf.js, line 398

Total time for App Cache, DNS, TCP, Request & Response

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getNetworkTime(){integer}

surfnperf.js, line 378

Total time for App Cache, DNS & TCP

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getProcessingLoadTime(){integer}

surfnperf.js, line 408

Total time to process the Response & fire the onLoad event

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getServerTime(){integer}

surfnperf.js, line 388

Total time for Request & Response

Returns:
Type Description
integer time in ms

staticSurfNPerf.SNPProto.getTimingMark(eventKey, timeType){DOMHighResTimeStamp|integer}

surfnperf.js, line 160

Returns the timing data for a particular eventKey

Name Type Description
eventKey String

name of the timing event
timeType String

'highRes' (to return a DOMHighResTimeStamp, if available) or 'DOM' (to return a DOMTimeStamp's value) - optional. Defaults to 'DOM'
Returns:
Type Description
DOMHighResTimeStamp | integer time value

staticSurfNPerf.SNPProto.isHidden(){boolean}

surfnperf.js, line 492

Is the page hidden or not, as reported by the Page Visibility API

Returns:
Type Description
boolean true if the page is in a state considered to be hidden to the user, and false otherwise.

staticSurfNPerf.SNPProto.markNow(){String}

surfnperf.js, line 295

Marks the current time

Returns:
Type Description
String name generated for the mark

staticSurfNPerf.SNPProto.now(timeType){DOMHighResTimeStamp|integer}

surfnperf.js, line 131

Returns the timing data for a particular eventKey

Name Type Description
timeType String

'highRes' (to return a DOMHighResTimeStamp, if available) or 'DOM' (to return a DOMTimeStamp's value) - optional. Defaults to 'highRes'
Returns:
Type Description
DOMHighResTimeStamp | integer time value