GTKX

API Reference / @gtkx/config / index / DeployScreenshotOptions

Type Alias: DeployScreenshotOptions ​

DeployScreenshotOptions = object

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

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

Type Declaration ​

caption? ​

optional caption?: string

Caption displayed with the screenshot in software centers.

file? ​

optional file?: string

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

isDefault? ​

optional isDefault?: boolean

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

url? ​

optional url?: string

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