IDefaultImagePluginOptions

Defined in: index.ts:67

Full configuration for the image plugin including defaulted and required options.

PropertiesCopy Anchor Link

cache?Copy Anchor Link

Defined in: index.ts:129

In-memory cache object, useful for cache sharing across plugins/tabs.

cacheConfig?Copy Anchor Link

Defined in: index.ts:132

Configure caching

collapsibleHeading?Copy Anchor Link

Defined in: index.ts:124

Optional heading added above fallback code blocks (H6 level, maps to Heading 5 in Word).

• false: No heading is inserted (only the code block).
• true: Inserts an H6 heading (###### ⚠️ Diagram Source (Render Fallback)).
• string: Inserts custom heading text at H6 level.

DefaultCopy Anchor Link

true

dpiCopy Anchor Link

Defined in: index.ts:140

Target resolution in DPI for calculating physical dimensions

errorMode?Copy Anchor Link

Defined in: index.ts:97

General image error behavior.

• "warn": Emits a styled, muted text run with alt text.
• "silent": Drops the node completely (0 relationships, 0 XML overhead).
• "throw": Rejects the toDocx conversion promise with the underlying Error.
• "placeholder": Uses custom options.placeholder image. If placeholder is omitted, emits a warning badge.

DefaultCopy Anchor Link

"warn"

fallbackImageTypeCopy Anchor Link

Defined in: index.ts:72

Fallback format to convert unsupported image types.

DefaultCopy Anchor Link

"png"

fixGeneratedSvgCopy Anchor Link

Defined in: index.ts:155

Applies generic fixes to known SVG rendering issues (e.g., Mermaid pie chart title alignment). Designed to be overridden to handle tool-specific quirks in generated SVGs.

ParametersCopy Anchor Link

svgCopy Anchor Link

string

Raw SVG string to transform.

metadataCopy Anchor Link

any

Optional metadata such as diagram type or render info.

ReturnsCopy Anchor Link

string

Modified SVG string.

imageResolverCopy Anchor Link

Defined in: index.ts:78

Image resolution function used to convert URL/base64/SVG to image options

maxAgeMinutesCopy Anchor Link

Defined in: index.ts:143

Duration in minutes after which cached records are removed as stale. Default: 7 days (10080 minutes).

maxHCopy Anchor Link

Defined in: index.ts:84

Max image height (in inches) for inserted image

maxWCopy Anchor Link

Defined in: index.ts:81

Max image width (in inches) for inserted image

mermaidFallback?Copy Anchor Link

Defined in: index.ts:106

Fallback strategy specifically for failed Mermaid diagrams (when data.mermaid is present).

• "code": Renders the raw Mermaid diagram definition as a formatted monospace code block.
• "warn": Emits a warning badge [Mermaid Diagram Error: ...].
• "silent": Drops the node completely.

DefaultCopy Anchor Link

"code" (or inherits "silent" if errorMode is "silent")

placeholder?Copy Anchor Link

Defined in: index.ts:87

Optional placeholder image (base64 or URL) used on errors

qualityCopy Anchor Link

Defined in: index.ts:75

Quality factor (0–1). Applies only to lossy formats (jpeg/webp/avif). Default: 0.92.

salt?Copy Anchor Link

Defined in: index.ts:137

Optional salt string used to differentiate cache keys for similar images (e.g., dark/light theme).

scaleCopy Anchor Link

Defined in: index.ts:69

Scale factor for base64 (data URL) images.

DefaultCopy Anchor Link

3

svgFallback?Copy Anchor Link

Defined in: index.ts:115

Fallback strategy for failed non-Mermaid SVGs.

• "warn": Emits styled muted text badge [Image: <alt or 'SVG unavailable'>].
• "code": Renders the raw SVG XML markup in a standard DOCX code block (lang: "xml").
• "silent": Drops the node completely.

DefaultCopy Anchor Link

"warn"