Tego Bot API Documentation v0.2.0

---

Tego Bot API Documentation / saveScreenshotToFile

Function: saveScreenshotToFile()

saveScreenshotToFile(result, filePath, _options?): Promise<void>

Defined in: botjs/src/screenshot.ts:445

Save screenshot to file

Parameters

result

ScreenshotResult

Screenshot result to save

filePath

string

File path (extension determines format)

_options?

SaveImageOptions

Returns

Promise<void>

Example

const screenshot = await quickScreenshot();

// Save as PNG (default)
await saveScreenshotToFile(screenshot, 'screenshot.png');

// Save as JPEG with quality
await saveScreenshotToFile(screenshot, 'screenshot.jpg', {
  format: 'jpg',
  quality: 90
});

// Save as WebP
await saveScreenshotToFile(screenshot, 'screenshot.webp', {
  format: 'webp',
  quality: 85
});