diff options
| author | Ruben Beltran del Rio <jj@r.bdr.sh> | 2025-12-16 00:27:49 +0100 |
|---|---|---|
| committer | Ruben Beltran del Rio <jj@r.bdr.sh> | 2025-12-16 00:30:14 +0100 |
| commit | 2fe4573882f3045690a64d92a206606d24c68859 (patch) | |
| tree | ac442aef584b90f66dd44d666cfe7ef813a172fa /dist/index.d.ts | |
| parent | 7baed6d27301e4cc870960d73806a925bdfaf406 (diff) | |
Diffstat (limited to 'dist/index.d.ts')
| -rw-r--r-- | dist/index.d.ts | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/dist/index.d.ts b/dist/index.d.ts index 5aa1192..f33fac9 100644 --- a/dist/index.d.ts +++ b/dist/index.d.ts @@ -34,7 +34,12 @@ * const canvas = createCanvas(1384, 1084); * await renderToCanvas(map, canvas); */ -export function renderToCanvas(map: ParsedMap, canvas: HTMLCanvasElement | Canvas, stageType?: StageType, overrides?: tConfiguration): Promise<void>; +export function renderToCanvas( + map: ParsedMap, + canvas: HTMLCanvasElement | Canvas, + stageType?: StageType, + overrides?: tConfiguration, +): Promise<void>; /** * Render a parsed Wardley map to an image stream * Only available in Node.js environments @@ -51,15 +56,20 @@ export function renderToCanvas(map: ParsedMap, canvas: HTMLCanvasElement | Canva * * @example * import { parse } from 'wmap-parser'; - * import { renderToImage } from 'wmap-renderer-canvas'; + * import { renderToImage, ImageType } from 'wmap-renderer-canvas'; * import fs from 'fs'; * * const map = parse(wmapSource); - * const stream = await renderToImage(map, 'png'); + * const stream = await renderToImage(map, ImageType.PNG); * const out = fs.createWriteStream('map.png'); * stream.pipe(out); */ -export function renderToImage(map: ParsedMap, imageType?: ImageType, stageType?: StageType, overrides?: tConfiguration): Promise<Stream>; +export function renderToImage( + map: ParsedMap, + imageType?: ImageType, + stageType?: StageType, + overrides?: tConfiguration, +): Promise<Stream>; export type ImageType = import("./image_type.js").ImageType; export { ImageType } from "./image_type.js"; export type StageType = import("./stage_type.js").StageType; |