- "html": "\n<p><img src=\"https://img.shields.io/github/tag/Kikobeats/browserless.svg?style=flat-square\">\n<a href=\"https://travis-ci.org/Kikobeats/browserless\"><img src=\"https://img.shields.io/travis/Kikobeats/browserless/master.svg?style=flat-square\"></a>\n<a href=\"https://coveralls.io/github/Kikobeats/browserless\"><img src=\"https://img.shields.io/coveralls/Kikobeats/browserless.svg?style=flat-square\"></a>\n<a href=\"https://david-dm.org/Kikobeats/browserless\"><img src=\"https://img.shields.io/david/Kikobeats/browserless.svg?style=flat-square\"></a>\n<a href=\"https://david-dm.org/Kikobeats/browserless#info=devDependencies\"><img src=\"https://img.shields.io/david/dev/Kikobeats/browserless.svg?style=flat-square\"></a>\n<a href=\"https://www.npmjs.org/package/browserless\"><img src=\"https://img.shields.io/npm/dm/browserless.svg?style=flat-square\"></a>\n<a href=\"https://paypal.me/Kikobeats\"><img src=\"https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square\"></a></p>\n<blockquote>\n<p>Simple & Functional Browser API.</p>\n</blockquote>\n<p>This module is an API simplification over <a href=\"https://github.com/GoogleChrome/puppeteer\">Chrome Headless API</a> for do common actions, like take an screenshot:</p>\n<pre><span class=\"hljs-keyword\">const</span> browserless = <span class=\"hljs-built_in\">require</span>(<span class=\"hljs-string\">'browserless'</span>)()\n\nbrowserless\n .screenshot(<span class=\"hljs-string\">'http://example.com'</span>, { <span class=\"hljs-attr\">device</span>: <span class=\"hljs-string\">'iPhone 6'</span> })\n .then(<span class=\"hljs-function\"><span class=\"hljs-params\">tmpStream</span> =></span> {\n <span class=\"hljs-built_in\">console</span>.log(<span class=\"hljs-string\">`your screenshot at <span class=\"hljs-subst\">${tmpStream.path}</span>`</span>)\n tmpStream.cleanupSync()\n })</pre><h2>Install</h2>\n<pre>$ npm install browserless --save</pre><h2>API</h2>\n<p>All methods needs a valid <code>url</code> as required first argument. The second argument will be <code>opts</code> for configure specific method settings.</p>\n<p>All methods expose an universal <code>promise</code>/<code>callback</code> interface: If you provide a function as last argument, then the output of the method will be following <code>callback</code> style. Otherwise, it returns an <code>promise</code>.</p>\n<h3>.constructor([opts])</h3>\n<p>Setup <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions\">puppeter.launch</a> instance.</p>\n<h3>.html(url, [opts], [cb])</h3>\n<p>It returns the full HTML extracted from the URL.</p>\n<p><code>opts</code> provided are passed to <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options\">page.goto</a>.</p>\n<h3>.pdf(url, [opts], [cb])</h3>\n<p><code>opts</code> provided are passed to <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options\">page.goto</a>.</p>\n<p>Additionally, you can setup:</p>\n<h3>media</h3>\n<p>Providing a valid <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulatemediamediatype\">page.emulateMedia</a> value. Default is <code>'screen'</code>.</p>\n<h3>.screenshot(url, [opts], [cb])</h3>\n<p>It takes an screenshot of the URL.</p>\n<p><code>opts</code> provided are passed to <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagescreenshotoptions\">page.screenshot</a>.</p>\n<p>Additionally, you can setup:</p>\n<h4>device</h4>\n<p>Providing a valid <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js\">deviceDescriptor</a> object.</p>\n<h4>viewport</h4>\n<p>Providing a valid <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetviewportviewport\">page.setViewport</a> object.</p>\n<p>It returns an <a href=\"https://github.com/Kikobeats/create-temp-file2#create-temp-file2\">tmpStream</a>, with <code>path</code> where the temporal file live and <code>cleanup</code>/<code>cleanupSync</code> methods for clean the temporal file.</p>\n<p>If you want to customize where tmpStream live, pass <a href=\"https://github.com/Kikobeats/create-temp-file2#createtempfileoptions\">opts.tmpOptions</a>.</p>\n<h3>.text(url, [options], [cb])</h3>\n<p>It returns the text extracted from the URL.</p>\n<p><code>opts</code> provided are passed to <a href=\"https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options\">page.goto</a>.</p>\n<h2>License</h2>\n<p><strong>browserless</strong> © <a href=\"https://kikobeats.com\">Kiko Beats</a>, Released under the <a href=\"https://github.com/Kikobeats/browserless/blob/master/LICENSE.md\">MIT</a> License.<br>\nAuthored and maintained by Kiko Beats with help from <a href=\"https://github.com/Kikobeats/browserless/contributors\">contributors</a>.</p>\n<blockquote>\n<p><a href=\"https://kikobeats.com\">kikobeats.com</a> · GitHub <a href=\"https://github.com/kikobeats\">Kiko Beats</a> · Twitter <a href=\"https://twitter.com/kikobeats\">@kikobeats</a></p>\n</blockquote>\n"
0 commit comments