puppeteer/next/api/puppeteer.httpresponse/index.html

22 lines
84 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/puppeteer.httpresponse" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">HTTPResponse class | Puppeteer</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pptr.dev/next/api/puppeteer.httpresponse"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:counter" content="3"><meta data-rh="true" property="og:title" content="HTTPResponse class | Puppeteer"><meta data-rh="true" name="description" content="The HTTPResponse class represents responses which are received by the Page class."><meta data-rh="true" property="og:description" content="The HTTPResponse class represents responses which are received by the Page class."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/next/api/puppeteer.httpresponse"><link data-rh="true" rel="alternate" href="https://pptr.dev/next/api/puppeteer.httpresponse" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/next/api/puppeteer.httpresponse" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://DVKY664LG7-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Puppeteer" href="/opensearch.xml">
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.67634aff.css">
<script src="/assets/js/runtime~main.0f0da6ba.js" defer="defer"></script>
<script src="/assets/js/main.07d48909.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_gu5v" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Puppeteer</b></a><a class="navbar__item navbar__link" href="/next/category/introduction">Docs</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/next/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/next/browsers-api/">@puppeteer/browsers API</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/next/">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/next/api/puppeteer.httpresponse">Next</a></li><li><a class="dropdown__link" href="/api/puppeteer.httpresponse">22.10.0</a></li><li><hr class="dropdown-separator"></li><li class="dropdown-archived-versions"><b>Archived versions</b></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.9.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.9.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.8.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.2<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.8.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.8.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M2
<p>The HTTPResponse class represents responses which are received by the <a href="/next/api/puppeteer.page">Page</a> class.</p>
<h4 class="anchor anchorWithStickyNavbar_FNw8" id="signature">Signature:<a class="hash-link" aria-label="Direct link to Signature:" title="Direct link to Signature:" href="/next/api/puppeteer.httpresponse#signature"></a></h4>
<div class="language-typescript codeBlockContainer_aalF theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_MHx8"><pre tabindex="0" class="prism-code language-typescript codeBlock_zHgq thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_RjmQ"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">declare</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">abstract</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> </span><span class="token class-name">HTTPResponse</span><br></span></code></pre><div class="buttonGroup_Sd8_"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_LnQD" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_t3l1"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_IiZV"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="remarks">Remarks<a class="hash-link" aria-label="Direct link to Remarks" title="Direct link to Remarks" href="/next/api/puppeteer.httpresponse#remarks"></a></h2>
<p>The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the <code>HTTPResponse</code> class.</p>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="methods">Methods<a class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods" href="/next/api/puppeteer.httpresponse#methods"></a></h2>
<table><thead><tr><th><p>Method</p></th><th><p>Modifiers</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><span id="buffer"><a href="/next/api/puppeteer.httpresponse.buffer">buffer()</a></span></td><td></td><td><p>Promise which resolves to a buffer with response body.</p><p><strong>Remarks:</strong></p><p>The buffer might be re-encoded by the browser based on HTTP-headers or other heuristics. If the browser failed to detect the correct encoding, the buffer might be encoded incorrectly. See <a href="https://github.com/puppeteer/puppeteer/issues/6478" target="_blank" rel="noopener noreferrer">https://github.com/puppeteer/puppeteer/issues/6478</a>.</p></td></tr><tr><td><span id="frame"><a href="/next/api/puppeteer.httpresponse.frame">frame()</a></span></td><td></td><td><p>A <a href="/next/api/puppeteer.frame">Frame</a> that initiated this response, or <code>null</code> if navigating to error pages.</p></td></tr><tr><td><span id="fromcache"><a href="/next/api/puppeteer.httpresponse.fromcache">fromCache()</a></span></td><td></td><td><p>True if the response was served from either the browser&#x27;s disk cache or memory cache.</p></td></tr><tr><td><span id="fromserviceworker"><a href="/next/api/puppeteer.httpresponse.fromserviceworker">fromServiceWorker()</a></span></td><td></td><td><p>True if the response was served by a service worker.</p></td></tr><tr><td><span id="headers"><a href="/next/api/puppeteer.httpresponse.headers">headers()</a></span></td><td></td><td><p>An object with HTTP headers associated with the response. All header names are lower-case.</p></td></tr><tr><td><span id="json"><a href="/next/api/puppeteer.httpresponse.json">json()</a></span></td><td></td><td><p>Promise which resolves to a JSON representation of response body.</p><p><strong>Remarks:</strong></p><p>This method will throw if the response body is not parsable via <code>JSON.parse</code>.</p></td></tr><tr><td><span id="ok"><a href="/next/api/puppeteer.httpresponse.ok">ok()</a></span></td><td></td><td><p>True if the response was successful (status in the range 200-299).</p></td></tr><tr><td><span id="remoteaddress"><a href="/next/api/puppeteer.httpresponse.remoteaddress">remoteAddress()</a></span></td><td></td><td><p>The IP address and port number used to connect to the remote server.</p></td></tr><tr><td><span id="request"><a href="/next/api/puppeteer.httpresponse.request">request()</a></span></td><td></td><td><p>A matching <a href="/next/api/puppeteer.httprequest">HTTPRequest</a> object.</p></td></tr><tr><td><span id="securitydetails"><a href="/next/api/puppeteer.httpresponse.securitydetails">securityDetails()</a></span></td><td></td><td><p><a href="/next/api/puppeteer.securitydetails">SecurityDetails</a> if the response was received over the secure connection, or <code>null</code> otherwise.</p></td></tr><tr><td><span id="status"><a href="/next/api/puppeteer.httpresponse.status">status()</a></span></td><td></td><td><p>The status code of the response (e.g., 200 for a success).</p></td></tr><tr><td><span id="statustext"><a href="/next/api/puppeteer.httpresponse.statustext">statusText()</a></span></td><td></td><td><p>The status text of the response (e.g. usually an &quot;OK&quot; for a success).</p></td></tr><tr><td><span id="text"><a href="/next/api/puppeteer.httpresponse.text">text()</a></span></td><td></td><td><p>Promise which resolves to a text (utf8) representation of response body.</p></td></tr><tr><td><span id="timing"><a href="/next/api/puppeteer.httpresponse.timing">timing()</a></span></td><td></td><td><p>Timing information related to the response.</p></td></tr><tr><td><span id="url"><a href="/next/api/puppeteer.httpresponse.url">url()</a></span></td><td></td><td><p>The URL of the response.</p></td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/next/api/puppeteer.httprequest.url"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">HTTPRequest.url</div></a><a class="pagin
</body>
</html>