gotenberg

package module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

README

Gotenberg Go Client

A comprehensive Go client for Gotenberg API with functional options pattern for clean and flexible usage.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	PaperSizeLetter  = [2]float64{8.5, 11}
	PaperSizeLegal   = [2]float64{8.5, 14}
	PaperSizeTabloid = [2]float64{11, 17}
	PaperSizeLedger  = [2]float64{17, 11}
	PaperSizeA0      = [2]float64{33.1, 46.8}
	PaperSizeA1      = [2]float64{23.4, 33.1}
	PaperSizeA2      = [2]float64{16.54, 23.4}
	PaperSizeA3      = [2]float64{11.7, 16.54}
	PaperSizeA4      = [2]float64{8.27, 11.7}
	PaperSizeA5      = [2]float64{5.83, 8.27}
	PaperSizeA6      = [2]float64{4.13, 5.83}
)

Functions

This section is empty.

Types

type Client

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

func NewClient

func NewClient(httpClient *http.Client, baseURL string) *Client

func (Client) ConvertHTMLToPDF

func (c Client) ConvertHTMLToPDF(ctx context.Context, indexHTML []byte, opts ...ConvOption) (*http.Response, error)

ConvertHTMLToPDF converts HTML to PDF

func (Client) ConvertMarkdownToPDF

func (c Client) ConvertMarkdownToPDF(ctx context.Context, indexHTML []byte, markdownFiles map[string][]byte, opts ...ConvOption) (*http.Response, error)

ConvertMarkdownToPDF converts Markdown to PDF

func (Client) ConvertURLToPDF

func (c Client) ConvertURLToPDF(ctx context.Context, url string, opts ...ConvOption) (*http.Response, error)

ConvertURLToPDF converts URL to PDF

type ConvOption added in v0.0.3

type ConvOption func(*convConfig)

func WithHTMLAdditionalFiles added in v0.0.3

func WithHTMLAdditionalFiles(files map[string][]byte) ConvOption

func WithHTMLFooter added in v0.0.3

func WithHTMLFooter(footerHTML []byte) ConvOption

func WithHTMLHeader added in v0.0.3

func WithHTMLHeader(headerHTML []byte) ConvOption

func WithLandscape

func WithLandscape(enabled bool) ConvOption

func WithMargins

func WithMargins(top, right, bottom, left float64) ConvOption

func WithOutputFilename

func WithOutputFilename(filename string) ConvOption

func WithPaperSize

func WithPaperSize(width, height float64) ConvOption

func WithPaperSizeA4 added in v0.0.3

func WithPaperSizeA4() ConvOption

func WithPaperSizeLetter added in v0.0.3

func WithPaperSizeLetter() ConvOption

func WithPrintBackground

func WithPrintBackground(enabled bool) ConvOption

func WithScale

func WithScale(scale float64) ConvOption

func WithSinglePage

func WithSinglePage(enabled bool) ConvOption

func WithWebhook

func WithWebhook(url, errorURL string) ConvOption

func WithWebhookExtraHeaders

func WithWebhookExtraHeaders(headers map[string]string) ConvOption

func WithWebhookMethods

func WithWebhookMethods(method, errorMethod string) ConvOption

Directories

Path Synopsis
example
cmd/html2pdf command
cmd/url2pdf command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL