resultWithImage

resultWithImage(result, imageData, options?): GadgetExecuteResultWithMedia

Defined in: gadgets/helpers.ts:241

Create a result with a single image output.

Parameters

result

string

Text result string

imageData

Raw image data (PNG, JPEG, GIF, WebP)

Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

options?

ImageOptions

Optional MIME type, description, metadata, cost

Returns

GadgetExecuteResultWithMedia

A GadgetExecuteResultWithMedia

Example

const screenshot = await page.screenshot({ type: "png" });
return resultWithImage(
  "Screenshot captured",
  screenshot,
  { description: "Homepage screenshot", metadata: { width: 1920, height: 1080 } }
);