polipage

package module

Go to main page

Versions in this module

v0

v0.13.0

Nov 4, 2026

Changes in this version

+ const ErrCodeIOError

+ const ErrCodeInvalidResponse

+ var ErrIOError = &Error

+ var ErrInvalidResponse = &Error

v0.11.0

Oct 30, 2026

Changes in this version

+ const ErrCodeDocumentGone

+ const ErrCodeDocumentTooLarge

+ const ErrCodeEmptyDocument

+ const ErrCodeEnvironmentMismatch

+ const ErrCodeEnvironmentProtected

+ const ErrCodeOrganizationMigrating

+ const ErrCodeOrganizationPaymentGrace

+ const ErrCodeProjectNotFound

+ const ErrCodeProjectNotInEnvironment

+ const ErrCodePublishInProgress

+ const ErrCodeRateLimitExceeded

+ const ErrCodeRenderBodyTooLarge

+ const ErrCodeRenderTimeout

+ const ErrCodeStorageAccessDenied

+ const ErrCodeTemplateError

+ const ErrCodeTemplateNotFound

+ const ErrCodeTemplateUnsafe

+ const ErrCodeThumbnailsNotAvailable

+ var ErrDocumentGone = &Error

type Payload

+ func (p Payload) MarshalJSON() ([]byte, error)

type RenderInput

+ Data map[string]any

+ Format PageFormat

+ Locale string

+ Metadata RenderMetadata

+ Orientation Orientation

+ Project string

+ Template string

type ThumbnailFormat

+ const ThumbnailFormatWebP

v0.9.0

Jun 16, 2026

Changes in this version

+ const DefaultBaseURL

+ const DefaultMaxRetries

+ const DefaultRetryDelay

+ const DefaultTimeout

+ const ErrCodeAPIInternalError

+ const ErrCodeAborted

+ const ErrCodeDocumentNotFound

+ const ErrCodeDownloadFailed

+ const ErrCodeForbidden

+ const ErrCodeGone

+ const ErrCodeIOFailed

+ const ErrCodeInternalError

+ const ErrCodeInvalidAPIKey

+ const ErrCodeInvalidOptions

+ const ErrCodeInvalidVersionForKeyEnv

+ const ErrCodeInvalidVersionFormat

+ const ErrCodeMissingAPIKey

+ const ErrCodeMissingData

+ const ErrCodeMissingProjectOrTemplate

+ const ErrCodeMissingTemplateSlug

+ const ErrCodeNetworkError

+ const ErrCodeNotFound

+ const ErrCodeOrganizationCancelled

+ const ErrCodeOrganizationPurged

+ const ErrCodeOverageCapExceeded

+ const ErrCodePaymentRequired

+ const ErrCodeProjectRequiredForDocument

+ const ErrCodeQuotaExceeded

+ const ErrCodeTimeout

+ const ErrCodeUnknownError

+ const ErrCodeValidationError

+ const ErrCodeVersionNotFound

+ const ErrCodeVersionRequired

+ var ErrAborted = &Error

+ var ErrDocumentNotFound = &Error

+ var ErrDownloadFailed = &Error

+ var ErrForbidden = &Error

+ var ErrGone = &Error

+ var ErrIOFailed = &Error

+ var ErrNetwork = &Error

+ var ErrNotFound = &Error

+ var ErrOrganizationCancelled = &Error

+ var ErrOrganizationPurged = &Error

+ var ErrPaymentRequired = &Error

+ var ErrRateLimit = &Error

+ var ErrTimeout = &Error

+ var ErrUnauthorized = &Error

+ var ErrValidation = &Error

+ var ErrVersionNotFound = &Error

+ func Opt[T any](v T) *T

+ func RenderToFile(ctx context.Context, c *Client, in ProjectModeInput, path string) error

+ type Client struct

+ Documents *Documents

+ Render *Render

+ func NewClient(opts ...option.RequestOption) *Client

+ type DocumentDescriptor struct

+ APIKeyID *string

+ CreatedAt string

+ DocumentID string

+ Environment Environment

+ ExpiresAt string

+ Format PageFormat

+ Locale *string

+ Metadata RenderMetadata

+ OrganizationID string

+ Orientation *string

+ PageCount int

+ PresignedPDFURL string

+ ProjectID *string

+ ProjectSlug *string

+ SizeBytes int64

+ TemplateID *string

+ TemplateSlug *string

+ Version *string

+ func (d *DocumentDescriptor) DownloadPDF(ctx context.Context, opts ...option.DownloadOption) ([]byte, error)

+ type DocumentPreviewResult struct

+ HTML string

+ PageCount int

+ type Documents struct

+ func (d *Documents) Delete(ctx context.Context, id string, opts ...option.RequestOption) error

+ func (d *Documents) Get(ctx context.Context, id string, opts ...option.RequestOption) (*DocumentDescriptor, error)

+ func (d *Documents) Preview(ctx context.Context, id string, opts ...option.RequestOption) (*DocumentPreviewResult, error)

+ func (d *Documents) Thumbnails(ctx context.Context, id string, options ThumbnailOptions, ...) ([]Thumbnail, error)

+ type Environment string

+ const EnvironmentLive

+ const EnvironmentSandbox

+ type Error struct

+ Cause error

+ Code string

+ Message string

+ RequestID string

+ StatusCode int

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) IsAuthError() bool

+ func (e *Error) IsNetworkError() bool

+ func (e *Error) IsRateLimitError() bool

+ func (e *Error) IsRetryable() bool

+ func (e *Error) IsValidationError() bool

+ func (e *Error) ToPayload() Payload

+ func (e *Error) Unwrap() error

+ type InlineModeInput struct

+ Data map[string]any

+ Format PageFormat

+ Locale string

+ Metadata RenderMetadata

+ Orientation Orientation

+ Template string

+ type Orientation string

+ const OrientationLandscape

+ const OrientationPortrait

+ type PageFormat string

+ const PageFormatA3

+ const PageFormatA4

+ const PageFormatA5

+ const PageFormatA6

+ const PageFormatB4

+ const PageFormatB5

+ const PageFormatExecutive

+ const PageFormatFolio

+ const PageFormatLegal

+ const PageFormatLetter

+ const PageFormatStatement

+ const PageFormatTabloid

+ type Payload struct

+ Code string

+ Message string

+ RequestID string

+ Status int

+ type PreviewResult struct

+ Environment Environment

+ HTML string

+ TotalPages int

+ type ProjectModeInput struct

+ Data map[string]any

+ Format PageFormat

+ Locale string

+ Metadata RenderMetadata

+ Orientation Orientation

+ Project string

+ Template string

+ Version *string

+ type Render struct

+ func (r *Render) Document(ctx context.Context, in ProjectModeInput, opts ...option.RequestOption) (*DocumentDescriptor, error)

+ func (r *Render) PDF(ctx context.Context, in ProjectModeInput, opts ...option.RequestOption) ([]byte, error)

+ func (r *Render) PDFStream(ctx context.Context, in ProjectModeInput, opts ...option.RequestOption) (io.ReadCloser, error)

+ func (r *Render) Preview(ctx context.Context, in RenderInput, opts ...option.RequestOption) (*PreviewResult, error)

+ type RenderInput interface

+ type RenderMetadata = map[string]any

+ type RequestEvent = clientconfig.RequestEvent

+ type ResponseEvent = clientconfig.ResponseEvent

+ type RetryEvent = clientconfig.RetryEvent

+ type Thumbnail struct

+ ContentType string

+ Data string

+ Height int

+ Page int

+ Width int

+ type ThumbnailFormat string

+ const ThumbnailFormatJPEG

+ const ThumbnailFormatPNG

+ type ThumbnailOptions struct

+ Format ThumbnailFormat

+ Pages []int

+ Quality int

+ Width int

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