Skip to main content

Overview

The ScreenshotAPI provides methods for capturing screenshots of websites with various options and configurations.

Methods

take()

Captures a screenshot with full configuration options.

Parameters

ScreenshotOptions

Returns

Promise<ScreenshotResult> - Screenshot result with data and metadata

ScreenshotResult

Examples

takeBatch()

Captures multiple screenshots in batch.

Parameters

BatchScreenshotOptions

Returns

Promise<BatchScreenshotResult> - Batch screenshot results

BatchScreenshotResult

Examples

screenshot()

Convenience method for basic screenshots.

Parameters

Returns

Promise<ScreenshotResult> - Screenshot result

Example

fullPage()

Convenience method for full-page screenshots.

Parameters

Returns

Promise<ScreenshotResult> - Full-page screenshot result

Example

element()

Convenience method for element screenshots.

Parameters

Returns

Promise<ScreenshotResult> - Element screenshot result

Example

Advanced Usage

Custom Timing

Performance Optimization

Error Handling

Batch Processing with Progress

File Format Details

PNG Format

  • Lossless compression: No quality loss
  • Supports transparency: Alpha channel
  • Larger file sizes: Better for screenshots with text
  • Default choice: Best quality for most use cases

JPEG Format

  • Lossy compression: Smaller file sizes
  • No transparency: White background for transparent elements
  • Quality range: 0-100 (default: 80)
  • Best for: Photographs, gradients, when file size matters

Viewport Considerations

Common Viewports

Device Pixel Ratio

Best Practices

Performance

  1. Use appropriate formats: PNG for quality, JPEG for size
  2. Set reasonable timeouts: Don’t wait unnecessarily long
  3. Batch when possible: Reduce overhead
  4. Cache results: Avoid redundant screenshots

Error Handling

Resource Management