aboutsummaryrefslogtreecommitdiff
path: root/dist/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'dist/index.d.ts')
-rw-r--r--dist/index.d.ts18
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;