ts-pptx

Appearance

@shbernal/ts-pptx

@shbernal/ts-pptx / index / WriteFileProps

Interface: WriteFileProps ​

Defined in: src/types/pres.ts:39

Extends ​

Properties ​

compression? ​

optional compression?: boolean

Defined in: src/types/pres.ts:17

Whether to DEFLATE-compress the package (PowerPoint itself always compresses; set false only if export time matters more than file size)

Default ​

ts
true

Inherited from ​

WriteBaseProps.compression

fileName? ​

optional fileName?: string

Defined in: src/types/pres.ts:44

Export file name

Default ​

ts
'Presentation.pptx'

onMediaError? ​

optional onMediaError?: "placeholder" | "throw"

Defined in: src/types/pres.ts:29

How to handle a media asset (image/audio/video) that fails to load during export.

  • 'throw' (default): reject the export with an error naming the failing asset. A deck that silently embeds a broken-image placeholder is a degenerate result, so failing loudly is the safe default.
  • 'placeholder': substitute a broken-image placeholder, emit a media/load-failed diagnostic (see setDiagnosticHandler), and continue. Useful for best-effort/batch jobs where one missing asset should not abort the whole deck.

Default ​

ts
'throw'

Inherited from ​

WriteBaseProps.onMediaError