What This Adds In Cloud Code
- Render HTML/SVG to image for previews/badges/tickets.
- Works in background jobs and callbacks.
- Returns base64 image data for downstream delivery.
Quick Start
js
const IMGKit = require('imgkit');
const imageBase64 = IMGKit.convert('<svg><text>OK</text></svg>', { format: 'png' });API
| Function | Params | Returns | Notes |
|---|---|---|---|
convert(html, options) | HTML/SVG string + options | string | Returns base64 image. |
Supported options include width, height, quality, format (png, jpg, jpeg).
Practical Example
js
const IMGKit = require('imgkit');
const badge = IMGKit.convert(
`<html><body><h1>${request.params.name}</h1></body></html>`,
{ format: 'png', width: 1200, height: 630 }
);
response.success({ badge_image: badge });Failure Modes & Gotchas
- Unsupported format falls back to
jpg. - In production, conversion errors can return empty string.