puppeteer/assets/js/383ae76a.fe169fdf.js

/*! For license information please see 383ae76a.fe169fdf.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[94104],{74317:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>h,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var t=r(85893),n=r(11151);const i={sidebar_label:"HTTPResponse"},p="HTTPResponse class",d={id:"api/puppeteer.httpresponse",title:"HTTPResponse class",description:"The HTTPResponse class represents responses which are received by the Page class.",source:"@site/versioned_docs/version-22.0.0/api/puppeteer.httpresponse.md",sourceDirName:"api",slug:"/api/puppeteer.httpresponse",permalink:"/api/puppeteer.httpresponse",draft:!1,unlisted:!1,tags:[],version:"22.0.0",frontMatter:{sidebar_label:"HTTPResponse"},sidebar:"api",previous:{title:"HTTPRequest.url",permalink:"/api/puppeteer.httprequest.url"},next:{title:"HTTPResponse.buffer",permalink:"/api/puppeteer.httpresponse.buffer"}},h={},o=[{value:"Signature:",id:"signature",level:4},{value:"Remarks",id:"remarks",level:2},{value:"Methods",id:"methods",level:2}];function a(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"httpresponse-class",children:"HTTPResponse class"}),"\n",(0,t.jsxs)(s.p,{children:["The HTTPResponse class represents responses which are received by the ",(0,t.jsx)(s.a,{href:"/api/puppeteer.page",children:"Page"})," class."]}),"\n",(0,t.jsx)(s.h4,{id:"signature",children:"Signature:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-typescript",children:"export declare abstract class HTTPResponse\n"})}),"\n",(0,t.jsx)(s.h2,{id:"remarks",children:"Remarks"}),"\n",(0,t.jsxs)(s.p,{children:["The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ",(0,t.jsx)(s.code,{children:"HTTPResponse"})," class."]}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Method"}),(0,t.jsx)(s.th,{children:"Modifiers"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.buffer",children:"buffer()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"Promise which resolves to a buffer with response body."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.frame",children:"frame()"})}),(0,t.jsx)(s.td,{}),(0,t.jsxs)(s.td,{children:["A ",(0,t.jsx)(s.a,{href:"/api/puppeteer.frame",children:"Frame"})," that initiated this response, or ",(0,t.jsx)("code",{children:"null"})," if navigating to error pages."]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.fromcache",children:"fromCache()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"True if the response was served from either the browser's disk cache or memory cache."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.fromserviceworker",children:"fromServiceWorker()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"True if the response was served by a service worker."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.headers",children:"headers()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"An object with HTTP headers associated with the response. All header names are lower-case."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.json",children:"json()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"Promise which resolves to a JSON representation of response body."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.ok",children:"ok()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"True if the response was successful (status in the range 200-299)."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.remoteaddress",children:"remoteAddress()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"The IP address and port number used to connect to the remote server."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.request",children:"request()"})}),(0,t.jsx)(s.td,{}),(0,t.jsxs)(s.td,{children:["A matching ",(0,t.jsx)(s.a,{href:"/api/puppeteer.httprequest",children:"HTTPRequest"})," object."]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.securitydetails",children:"securityDetails()"})}),(0,t.jsx)(s.td,{}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"/api/puppeteer.securitydetails",children:"SecurityDetails"})," if the response was received over the secure connection, or ",(0,t.jsx)("code",{children:"null"})," otherwise."]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.status",children:"status()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"The status code of the response (e.g., 200 for a success)."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.statustext",children:"statusText()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:'The status text of the response (e.g. usually an "OK" for a success).'})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.text",children:"text()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"Promise which resolves to a text representation of response body."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.timing",children:"timing()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"Timing information related to the response."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/api/puppeteer.httpresponse.url",children:"url()"})}),(0,t.jsx)(s.td,{}),(0,t.jsx)(s.td,{children:"The URL of the response."})]})]})]})]})}function c(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},75251:(e,s,r)=>{var t=r(67294),n=Symbol.for("react.element"),i=Symbol.for("react.fragment"),p=Object.prototype.hasOwnProperty,d=t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,h={key:!0,ref:!0,__self:!0,__source:!0};function o(e,s,r){var t,i={},o=null,a=null;for(t in void 0!==r&&(o=""+r),void 0!==s.key&&(o=""+s.key),void 0!==s.ref&&(a=s.ref),s)p.call(s,t)&&!h.hasOwnProperty(t)&&(i[t]=s[t]);if(e&&e.defaultProps)for(t in s=e.defaultProps)void 0===i[t]&&(i[t]=s[t]);return{$$typeof:n,type:e,key:o,ref:a,props:i,_owner:d.current}}s.Fragment=i,s.jsx=o,s.jsxs=o},85893:(e,s,r)=>{e.exports=r(75251)},11151:(e,s,r)=>{r.d(s,{Z:()=>d,a:()=>p});var t=r(67294);const n={},i=t.createContext(n);function p(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:p(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]);