Skip to content

Note: Headless Hack #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
togmund wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Note: Headless Hack #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@ npm install @autotelic/fastify-pdf-export
## Usage

```js
import Fastify from 'fastify'
import fastifyPdfExport from 'fastify-pdf-export'
import Fastify from 'fastify';
import fastifyPdfExport from 'fastify-pdf-export';

const fastify = Fastify()
const fastify = Fastify();

fastify.register(fastifyPdfExport)
fastify.register(fastifyPdfExport);

fastify.get('/', async (request, reply) => {
const { pdfExport } = fastify
const { pdf } = await pdfExport({
pdfUrl: 'http://example.com'
})
reply.type('application/pdf').send(pdf)
})

fastify.listen({ port: 3000 }, err => {
if (err) throw err
console.log(`Server listening on ${fastify.server.address().port}`)
})
const { pdfExport } = fastify;
const { pdf } = await pdfExport({
pdfUrl: 'http://example.com',
});
reply.type('application/pdf').send(pdf);
});

fastify.listen({ port: 3000 }, (err) => {
if (err) throw err;
console.log(`Server listening on ${fastify.server.address().port}`);
});
```

## API
Expand All @@ -48,6 +48,10 @@ Generates a PDF from the specified URL.
- `pdfOptions` (`PDFOptions`): **Optional**. Configuration options for the PDF generation, as defined by Puppeteer's [`PDFOptions`](https://pptr.dev/api/puppeteer.pdfoptions). This includes settings such as `format`, `margin`, `printBackground`, etc.
- `launchOptions` (`BrowserLaunchArgumentOptions`): **Optional**. Configuration options for launching the Puppeteer browser instance, as defined by Puppeteer's [`BrowserLaunchArgumentOptions`](https://pptr.dev/api/puppeteer.browserlaunchargumentoptions). This includes settings such as `headless`, `args`, `ignoreHTTPSErrors`, etc. By default, `headless` is set to `new`.

> [!NOTE]
> Some docker environments [experience](https://github.com/puppeteer/puppeteer/issues/11640) [issues](https://github.com/puppeteer/puppeteer/issues/12189) [with](https://github.com/puppeteer/puppeteer/issues/12864) [timeouts](https://github.com/puppeteer/puppeteer/issues/13048).
> One [possible solution](https://github.com/puppeteer/puppeteer/issues/1610#issuecomment-352197261) is to set `headless: false` and add the `--headless` flag to `args`, as `headless: true` and `headless: new` add other invisible flags to the `args` array.

##### Returns

A promise that resolves to an object containing:
Expand All @@ -61,6 +65,6 @@ A promise that resolves to an object containing:
const { pdf, error } = await fastify.pdfExport({
pdfUrl: 'http://example.com',
pdfOptions: { format: 'A4' },
launchOptions: { headless: 'new' }
launchOptions: { headless: 'new' },
});
```