API Reference / @gtkx/config / @gtkx/config / DeployScreenshotOptions

Type Alias: DeployScreenshotOptions ​

DeployScreenshotOptions = object

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

One software-center screenshot in deploy.screenshots. Either url or file must be set.

Properties ​

caption? ​

optional caption?: string

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

Caption displayed with the screenshot in software centers.

Default Value ​

None: the screenshot has no caption

file? ​

optional file?: string

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

Screenshot path relative to the project root, resolved against screenshotBaseUrl.

Default Value ​

None; each entry sets url or file

isDefault? ​

optional isDefault?: boolean

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

Marks the primary screenshot. Only the first entry set to true is used.

Default Value ​

false; when no entry sets it, no screenshot is marked primary

url? ​

optional url?: string

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

Absolute URL of a PNG or JPEG screenshot. Takes precedence over file.

Default Value ​

None; each entry sets url or file