Generate

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

Prefer the Fluent API for simple workflows

For chained operations like generate → transform → save, the Fluent API provides a cleaner syntax:

await floimg.generate('openai', { prompt: '...' }).transform('resize', { width: 800 }).to('./out.png');

Basic Usage

const image = await floimg.generate({
  generator: 'openai',
  params: {
    prompt: 'A mountain landscape at sunset',
    size: '1024x1024'
  }
});

Parameters

Parameter	Type	Required	Description
generator	string	Yes	Name of the registered generator
params	object	Yes	Generator-specific parameters

Return Value

Returns a Blob representing the generated image.

Registering Generators

Before using a generator, you must register it:

import createClient from '@teamflojo/floimg';
import openai from '@teamflojo/floimg-openai';
import quickchart from '@teamflojo/floimg-quickchart';

const floimg = createClient();
floimg.registerGenerator(openai({ apiKey: process.env.OPENAI_API_KEY }));
floimg.registerGenerator(quickchart());

Error Handling

try {
  const image = await floimg.generate({
    generator: 'openai',
    params: { prompt: 'A landscape' }
  });
} 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

See Also

• Fluent API - Chain operations with builder pattern
• Transform - Modify generated images
• Save - Output images to storage
• Plugins - Available generators