Skip to content

export.ExportMain.Interface.ExportOutputTypeZipOptions

Christian d'Heureuse edited this page Nov 16, 2026 · 1 revision

tedious-plus / export/ExportMain / ExportOutputTypeZipOptions

Interface: ExportOutputTypeZipOptions

Defined in: export/ExportMain.ts:98

Options for exporting into an entry (subfile) of a ZIP archive.

This uses the experimental ZIP API of Node.js.

Properties

entryName

entryName: string;

Defined in: export/ExportMain.ts:113

The name of the entry within the ZIP archive.


ifExists?

ifExists?: "replaceArchive" | "addEntry";

Defined in: export/ExportMain.ts:126

What to do when the ZIP archive already exists.

  • "replaceArchive": The whole ZIP archive is replaced by a new archive with only this entry.
  • "addEntry": The entry is added to the existing ZIP archive. The export fails if the archive already contains an entry with the same name.

In both cases, the ZIP archive is created if it does not exist.

Default Value

"replaceArchive"

type

type: "zip";

Defined in: export/ExportMain.ts:103

The output type.


zipPath

zipPath: string;

Defined in: export/ExportMain.ts:108

The path of the ZIP archive.

Clone this wiki locally