client.render.pdf_stream

client.render.pdf_stream(project:, template:, data:, version: nil, format: nil, orientation: nil, locale: nil, metadata: nil, idempotency_key: nil, &block)

Streaming form of #pdf. With a block, yields raw chunks (binary bytes) as they arrive. Without a block, returns an Enumerator so the caller can .each, .first(n), pipe into Enumerable chains, etc.

Returns

Enumerator, nil

Errors

Code	When
PoliPage::ValidationError	See [errors](../../../production/errors/) for the full description.
PoliPage::NotFoundError	See [errors](../../../production/errors/) for the full description.
PoliPage::RateLimitError	See [errors](../../../production/errors/) for the full description.
PoliPage::TimeoutError	See [errors](../../../production/errors/) for the full description.
PoliPage::ConnectionError	See [errors](../../../production/errors/) for the full description.
PoliPage::DownloadError	See [errors](../../../production/errors/) for the full description.
PoliPage::InternalError	See [errors](../../../production/errors/) for the full description.
PoliPage::APIError	See [errors](../../../production/errors/) for the full description.

Example

# frozen_string_literal: true

# Demonstrates: client.render.pdf_stream — stream PDF chunks with bounded memory.
require "poli_page"

client = PoliPage::Client.new(api_key: ENV.fetch("POLI_PAGE_API_KEY"))

# Block form — pipe straight to a file. The block is yielded raw chunks
# (binary Strings) as they arrive from the presigned URL.
File.open("invoice.pdf", "wb") do |io|
  client.render.pdf_stream(
    project:  "billing",
    template: "invoice",
    data:     { invoice_number: "INV-001", total: 1280 }
  ) { |chunk| io.write(chunk) }
end

# Enumerator form — when no block is given. Useful for piping through
# Enumerable chains or summing bytes for logging.
total = client.render.pdf_stream(
  project:  "billing",
  template: "invoice",
  data:     { invoice_number: "INV-001", total: 1280 }
).sum(&:bytesize)
puts "streamed #{total} bytes"

See also

• Errors
• Configuration