API Reference / @gtkx/config / @gtkx/config / DeployAppImageOptions

Type Alias: DeployAppImageOptions ​

DeployAppImageOptions = object

Defined in: packages/config/src/deploy.ts:481

The deploy.appimage options: AppImage file name, compression, update information and runtime.

Properties ​

compression? ​

optional compression?: "zstd"

Defined in: packages/config/src/deploy.ts:494

Compression explicitly requested from appimagetool.

Default Value ​

None: appimagetool's own default, as GTKX passes no --comp

fileName? ​

optional fileName?: string

Defined in: packages/config/src/deploy.ts:488

Output file name.

Default Value ​

<name>-<version>-<arch>.AppImage, with spaces in the display name replaced by underscores, such as My_App-1.2.0-x86_64.AppImage

runtimeFile? ​

optional runtimeFile?: string

Defined in: packages/config/src/deploy.ts:507

Custom AppImage runtime file path, resolved relative to the project root.

Default Value ​

A pinned type2-runtime release that gtkx deploy downloads and verifies against its sha256

updateInformation? ​

optional updateInformation?: string

Defined in: packages/config/src/deploy.ts:500

AppImage update information string embedded in the executable.

Default Value ​

None: the AppImage embeds no update information, as GTKX passes no -u