puppeteer/assets/js/4094812b.e9772cac.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[10514],{3905:function(e,t,r){r.d(t,{Zo:function(){return u},kt:function(){return m}});var n=r(67294);function p(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){p(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,n,p=function(e,t){if(null==e)return{};var r,n,p={},a=Object.keys(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||(p[r]=e[r]);return p}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)r=a[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(p[r]=e[r])}return p}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},u=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,p=e.mdxType,a=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=c(r),m=p,f=d["".concat(l,".").concat(m)]||d[m]||s[m]||a;return r?n.createElement(f,o(o({ref:t},u),{},{components:r})):n.createElement(f,o({ref:t},u))}));function m(e,t){var r=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var a=r.length,o=new Array(a);o[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:p,o[1]=i;for(var c=2;c<a;c++)o[c]=r[c];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},2954:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return i},contentTitle:function(){return l},metadata:function(){return c},toc:function(){return u},default:function(){return d}});var n=r(87462),p=r(63366),a=(r(67294),r(3905)),o=["components"],i={},l=void 0,c={unversionedId:"puppeteer.page.createpdfstream",id:"version-10.1.0/puppeteer.page.createpdfstream",isDocsHomePage:!1,title:"puppeteer.page.createpdfstream",description:"Home &gt; puppeteer &gt; Page &gt; createPDFStream",source:"@site/versioned_docs/version-10.1.0/puppeteer.page.createpdfstream.md",sourceDirName:".",slug:"/puppeteer.page.createpdfstream",permalink:"/puppeteer/docs/puppeteer.page.createpdfstream",editUrl:"https://github.com/facebook/puppeteer/edit/main/website/versioned_docs/version-10.1.0/puppeteer.page.createpdfstream.md",version:"10.1.0",frontMatter:{},sidebar:"version-10.1.0/docs",previous:{title:"puppeteer.page.cookies",permalink:"/puppeteer/docs/puppeteer.page.cookies"},next:{title:"puppeteer.page.deletecookie",permalink:"/puppeteer/docs/puppeteer.page.deletecookie"}},u=[{value:"Page.createPDFStream() method",id:"pagecreatepdfstream-method",children:[]},{value:"Parameters",id:"parameters",children:[]},{value:"Remarks",id:"remarks",children:[]}],s={toc:u};function d(e){var t=e.components,r=(0,p.Z)(e,o);return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/index"},"Home")," ",">"," ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/puppeteer"},"puppeteer")," ",">"," ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/puppeteer.page"},"Page")," ",">"," ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/puppeteer.page.createpdfstream"},"createPDFStream")),(0,a.kt)("h2",{id:"pagecreatepdfstream-method"},"Page.createPDFStream() method"),(0,a.kt)("p",null,"Generatees a PDF of the page with the ",(0,a.kt)("inlineCode",{parentName:"p"},"print")," CSS media type."),(0,a.kt)("b",null,"Signature:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"createPDFStream(options?: PDFOptions): Promise<Readable>;\n")),(0,a.kt)("h2",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"options"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"/puppeteer/docs/puppeteer.pdfoptions"},"PDFOptions")),(0,a.kt)("td",{parentName:"tr",align:null},"options for generating the PDF.")))),(0,a.kt)("b",null,"Returns:"),(0,a.kt)("p",null,"Promise","<","Readable",">"),(0,a.kt)("h2",{id:"remarks"},"Remarks"),(0,a.kt)("p",null,"NOTE: PDF generation is only supported in Chrome headless mode."),(0,a.kt)("p",null,"To generate a PDF with the ",(0,a.kt)("inlineCode",{parentName:"p"},"screen")," media type, call ",(0,a.kt)("a",{parentName:"p",href:"/puppeteer/docs/puppeteer.page.emulatemediatype"},"`","page.emulateMediaType('screen')","`")," before calling ",(0,a.kt)("inlineCode",{parentName:"p"},"page.pdf()"),"."),(0,a.kt)("p",null,"By default, ",(0,a.kt)("inlineCode",{parentName:"p"},"page.pdf()")," generates a pdf with modified colors for printing. Use the ",(0,a.kt)("a",{parentName:"p",href:"https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust"},"`","-webkit-print-color-adjust","`")," property to force rendering of exact colors."))}d.isMDXComponent=!0}}]);