PptxGenJS

Appearance

@shbernal/pptxgenjs

@shbernal/pptxgenjs / index / WriteProps

Interface: WriteProps ​

Defined in: core-interfaces.ts:2779

Extends ​

Properties ​

compression? ​

optional compression?: boolean

Defined in: core-interfaces.ts:2766

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

Default ​

ts
true

Since ​

v3.5.0 (default changed false→true in v4.0.0)

Inherited from ​

WriteBaseProps.compression

onMediaError? ​

optional onMediaError?: "throw" | "placeholder"

Defined in: core-interfaces.ts:2777

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 console.warn, 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

outputType? ​

optional outputType?: WRITE_OUTPUT_TYPE

Defined in: core-interfaces.ts:2785

Output type

  • values: 'arraybuffer' | 'base64' | 'binarystring' | 'blob' | 'nodebuffer' | 'uint8array' | 'STREAM'

Default ​

ts
'blob'