satoru-render 1.0.0 → 1.0.2

package/README.md

@@ -350,12 +350,12 @@ npx satoru-render input.html -f webp --verbose
 | :---------------- | :----------------------------------------- | :------------------------------------------------------ |
 | `value`           | `string \| string[] \| HTMLElement \| ...` | HTML string, array of strings, or DOM element(s).       |
 | `url`             | `string`                                   | URL to fetch HTML from.                                 |
-| `width`           | `number`                                   | **Required.** Output width in pixels.                   |
-| `height`          | `number`                                   | Output height. Default: `0` (auto-calculate).           |
+| `width`           | `number`                                   | **Required.** Canvas width in pixels (used for layout). |
+| `height`          | `number`                                   | Canvas height. Default: `0` (auto-calculate).           |
 | `crop`            | `{ x, y, width, height }`                  | Crop parameters to extract a specific region.           |
-| `outputWidth`     | `number`                                   | Target output width when scaling the image.             |
-| `outputHeight`    | `number`                                   | Target output height when scaling the image.            |
-| `fit`             | `"contain" \| "cover" \| "fill"`           | Resizing behavior when output scale differs.            |
+| `outputWidth`     | `number`                                   | Output image width. Default: canvas/crop width.         |
+| `outputHeight`    | `number`                                   | Output image height. Default: canvas/crop height.       |
+| `fit`             | `"contain" \| "cover" \| "fill"`           | Fit strategy when canvas/crop size differs from output. |
 | `format`          | `"svg" \| "png" \| "webp" \| "pdf"`        | Output format. Default: `"svg"`.                        |
 | `resolveResource` | `ResourceResolver`                         | Async callback to fetch assets (fonts, images, CSS).    |
 | `fonts`           | `Object[]`                                 | Pre-load fonts: `[{ name, data: Uint8Array }]`.         |

package/dist/core.d.ts

@@ -36,19 +36,28 @@ export interface ResolvedFontResult {
 }
 export type ResourceResolver = (resource: RequiredResource, defaultResolver: (resource: RequiredResource) => Promise<Uint8Array | ResolvedFontResult | null>) => Promise<Uint8Array | ArrayBufferView | ResolvedFontResult | null>;
 export interface RenderOptions {
+    /** Input content (HTML string or state object) */
     value?: string | string[] | any | any[];
+    /** Source URL */
     url?: string;
+    /** Canvas width for layout (used for CSS calculations) */
     width: number;
+    /** Canvas height for layout. If omitted, determined automatically by content height */
     height?: number;
+    /** Cropping options for the source canvas */
     crop?: {
         x: number;
         y: number;
         width: number;
         height: number;
     };
+    /** Final output image width. Defaults to width (or crop.width) */
     outputWidth?: number;
+    /** Final output image height. Defaults to height (or crop.height) */
     outputHeight?: number;
+    /** Resizing strategy to fit the canvas into the output size (default: "contain") */
     fit?: "contain" | "cover" | "fill";
+    /** Output format */
     format?: "svg" | "png" | "webp" | "pdf";
     textToPaths?: boolean;
     resolveResource?: ResourceResolver;