Skip to main content

Interface: AppImageOptions

Extends​

Properties​

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template.

Inherited from​

TargetSpecificOptions.artifactName

category?​

readonly optional category?: string | null

The application category.

Inherited from​

CommonLinuxOptions.category

compression?​

readonly optional compression?: "xz" | "gzip" | "zstd" | null

The compression algorithm passed to the AppImage build tool.

FUSE2 toolset ("0.0.0" or unset): "xz" is forwarded as --compression xz. "gzip", "zstd", null, and unset all fall through to the root-level compression option:

  • "maximum" → --compression xz (overrides any per-target gzip/zstd value)
  • anything else → flag omitted (mksquashfs defaults to gzip)

Static-runtime toolsets (>= 1.0.0): "gzip" and "zstd" are forwarded directly. "xz" is mapped to "zstd" (nearest supported equivalent). null or unset falls through to the root-level compression option:

  • "store" → "gzip"
  • "normal" / "maximum" / unset → "zstd"

description?​

readonly optional description?: string | null

As description from application package.json, but allows you to specify different for Linux.

Inherited from​

CommonLinuxOptions.description

desktop?​

readonly optional desktop?: LinuxDesktopFile | null

The Desktop file

Inherited from​

CommonLinuxOptions.desktop

executableArgs?​

readonly optional executableArgs?: string[] | null

The executable parameters. Pass to executableName

Inherited from​

CommonLinuxOptions.executableArgs

license?​

readonly optional license?: string | null

The path to EULA license file. Defaults to license.txt or eula.txt (or uppercase variants). Only plain text is supported.

mimeTypes?​

readonly optional mimeTypes?: string[] | null

The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.

Inherited from​

CommonLinuxOptions.mimeTypes

publish?​

optional publish?: Publish

Inherited from​

TargetSpecificOptions.publish

synopsis?​

readonly optional synopsis?: string | null

The short description.

Inherited from​

CommonLinuxOptions.synopsis