IronFlowDocs

image_resize

Resize a single image file.

Parameters

pathstringone of path or source_key
Source image path (supports ${ctx.key} interpolation).
source_keystringone of path or source_key
Context key containing either a path string, or an object entry { path = "..." } / { base64 = "..." }.
output_pathstringrequired
Destination file path for the resized image.
widthnumber
Target width in px. Required if height is omitted.
heightnumber
Target height in px. Required if width is omitted.
formatstringdefault inferred from output_path or png
Output format: png, jpeg, or jpg.
output_keystringdefault "resized_image"
Prefix for the generated context output keys.

If both path and source_key are provided, execution fails.

Context Output

  • <output_key> — output file path.
  • <output_key>_width — output width in pixels.
  • <output_key>_height — output height in pixels.
  • <output_key>_format — output format ("png" or "jpeg").
  • <output_key>_successtrue on success.

Example

local flow = Flow.new("image_resize_demo")

flow:step("resize", nodes.image_resize({
    path = "examples/fixtures/ironflow-sample.png",
    output_path = "outputs/sample_front_small.png",
    width = 120
}))

flow:step("log", nodes.log({
    message = "Resized to ${ctx.resized_image_width}x${ctx.resized_image_height}"
})):depends_on("resize")

return flow

IronFlow documentation

Find the next step

Type a keyword to search the documentation.

to move · Enter to open · Esc to close