Skip to content

Generate

The generate method creates images from structured parameters using registered generators.

const image = await floimg.generate({
generator: 'quickchart',
params: {
type: 'bar',
data: { /* Chart.js config */ }
}
});
ParameterTypeRequiredDescription
generatorstringYesName of the registered generator
paramsobjectYesGenerator-specific parameters

Returns a Blob representing the generated image.

Before using a generator, you must register it:

import createClient from '@teamflojo/floimg';
import quickchart from '@teamflojo/floimg-quickchart';
import qr from '@teamflojo/floimg-qr';
const floimg = createClient();
floimg.registerGenerator(quickchart());
floimg.registerGenerator(qr());
try {
const image = await floimg.generate({
generator: 'quickchart',
params: { type: 'bar', data: {} }
});
} catch (error) {
console.error('Generation failed:', error.message);
}

Common errors:

  • Generator not found - Generator not registered
  • Invalid params - Parameters don’t match generator schema
  • Generation failed - Generator-specific error
  • Transform - Modify generated images
  • Save - Output images to storage
  • Plugins - Available generators