Options
All
  • Public
  • Public/Protected
  • All
Menu

Information about the IPageRequest transaction (request and it's response).

Hierarchy

  • IPageResponse

Index

Properties

contentErrors

contentErrors: any[]

runtime errors unhandled by the content will be shown here

cookies

cookies: ICookie[]

cookies set at the moment the IPageRequest transaction completed.

Optional doneDetail

doneDetail: IDoneDetail

new for Chrome backend. information on what finished the page execution. In addition to pageExecLastWaitedOn, eventPhase and resources, this is useful for debugging your requests.

errors

errors: any[]

any errors raised during page execution will be shown here

Optional eventPhase

eventPhase: IPageDomEvent

new for Chrome backend. information on what event phase the page was in when it finished processing. In addition to pageExecLastWaitedOn, doneDetail and resources, this is useful for debugging your requests.

events

events: Array<object>

events that occured during requesting and loading of the IPageRequest and it's content

frameData

frameData: IPageFrame

the Frames contained in the page. The first is always the main page itself, even if no other frames are present.

headers

headers: object

headers for the primary resource (the url requested). for headers of other resources, inspect the pageResponse.events (key='resourceReceived')

Type declaration

  • [name: string]: string

metrics

metrics: object

information about the processing of your request

Type declaration

  • elapsedMs: number
  • endTime: string
  • pageStatus: string
  • startTime: string

Optional pageExecLastWaitedOn

pageExecLastWaitedOn: string

new for Chrome backend. displays the last thing that the page execution subsystem was waiting on. In addition to doneDetail and resources, this is useful for debugging your requests

pageRequest

pageRequest: IPageRequest

the request you sent, including defaults for any parameters you did not include

Optional resourceSummary

resourceSummary: IResourceSummary

new for Chrome backend. summary of all resources requested during the page execution, and their current status upon page completion. see resources for detailed listings

Optional resources

resources: string[]

new for Chrome backend. details all resource load times, ordered by when they started. This aggrigates resource details from events into an easy to read format. In addition to doneDetail, eventPhase and pageExecLastWaitedOn, this is useful for debugging your requests.

Provides the following details:

elapsed: how long the resource took to load in ms

detail: details on the resource's ending state. format is STATE.STATUSCODE.STATUSMESSAGE

  • STATE: complete, active (was still loading when the page finished), late (was still loading, and took longer than IRequestSettings.resourceWait allows), or killed (took longer than IRequestSettings.resourceTimeout allows so was aborted).
  • STATUSCODE: numeric statusCode recieved from the resource's remote server. If the request was aborted locally, the status will be 504. If an error occured without a response from the remote server, status 502 is used.
  • STATUSMESSAGE: describes the state and/or statusCode

start: the time in ms since page started execution, and what phase the page execution was in when the resource was requested:

  • initialRequest: the first resource has not finished yet.
  • pageNavigated: the dom has not finished loading yet (page is usually blank at this point).
  • domReady the dom is loaded and you can visually see the page, but it's not done yet.
  • load: the page is considered complete.

ended: the time in ms since page started execution, and what phase the page execution was in when the resource was finished. see started for a description of these phases. If the resource did not finish you will see a time of Infinity and phase of (undefined).

frame: the frame requested the resource (last 4 digits of it's frameId). if it's the main frame, we put "main" as it's name. additionally, if the request was a navigation of the frame, (nav) is added.

type: the type of the resource: document | stylesheet | image | media | font | script | texttrack | xhr | fetch | eventsource | websocket | manifest | other

url: the url of the resource. if it's longer than 100 characters, the first and last 50 characters will be shown.

example

["{elapsed:12,detail:'complete:200:OK',start:'124(initialRequest)',ended:'136(initialRequest)',frame:'main(nav)',type:'document',url:''http://localhost/blank''}"]

scriptOutput

scriptOutput: any

run a script and direct output to

statusCode

statusCode: number

the status code for the page, a shortcut to metrics.targetUrlReceived.value.status