pdfkit

README

pdfkit

Easy PDF printing via the Chrome DevTools Protocol.

Documentation

Index

• Variables
• type Config
• type LogError
  • func (e *LogError) Error() string
• type Printer
  • func CreatePrinter(config Config) (*Printer, error)
  • func (p *Printer) Close() error
  • func (p *Printer) PrintFile(file []byte, timeout time.Duration, assets map[string][]byte) ([]byte, error)
  • func (p *Printer) PrintURL(url string, timeout time.Duration) ([]byte, error)

Variables

var ErrClosed = errors.New("closed")

ErrClosed is returned if the printer has been closed.

var ErrProcessTimeout = errors.New("process timeout")

ErrProcessTimeout is returned if a job timed out while processing.

var ErrQueueTimeout = errors.New("queue timeout")

ErrQueueTimeout is returned if a job timed out while queueing.

Types

type Config

type Config struct {
	QueueSize   int
	Concurrency int
	ServerPort  int
	Logger      func(interface{})
}

Config defines a printer configuration.

type LogError

type LogError struct {
	Lines []string
}

LogError may be returned if the processing failed due to a page error.

func (*LogError) Error

func (e *LogError) Error() string

type Printer

type Printer struct {
	// contains filtered or unexported fields
}

Printer prints web pages as PDFs.

func CreatePrinter

func CreatePrinter(config Config) (*Printer, error)

CreatePrinter will create a new printer.

func (*Printer) Close

func (p *Printer) Close() error

Close will close the printer. It will wait for currently processing jobs to finish and cancels queued but not started jobs.

func (*Printer) PrintFile

func (p *Printer) PrintFile(file []byte, timeout time.Duration, assets map[string][]byte) ([]byte, error)

PrintFile will print the provided file and its assets as a PDF.

func (*Printer) PrintURL

func (p *Printer) PrintURL(url string, timeout time.Duration) ([]byte, error)

PrintURL will print the provided URL as a PDF.