Header menu logo fable-electron-docs-api

Options Type

Constructors

Constructor Description

Options(?applicationName, ?applicationVersion, ?copyright, ?version, ?credits, ?authors, ?website, ?iconPath)

Full Usage: Options(?applicationName, ?applicationVersion, ?copyright, ?version, ?credits, ?authors, ?website, ?iconPath)

Parameters:
    ?applicationName : string - The app's name.
    ?applicationVersion : string - The app's version.
    ?copyright : string - Copyright information.
    ?version : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || The app's build version number.
    ?credits : string - ⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Credit information.
    ?authors : string[] - ⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ || List of app authors.
    ?website : string - ⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ || The app's website.
    ?iconPath : string - ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ || Path to the app's icon in a JPEG or PNG file format. On Linux, will be shown as 64x64 pixels while retaining aspect ratio. On Windows, a 48x48 PNG will result in the best visual quality.

Returns: Options
?applicationName : string

The app's name.

?applicationVersion : string

The app's version.

?copyright : string

Copyright information.

?version : string

⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || The app's build version number.

?credits : string

⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Credit information.

?authors : string[]

⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ || List of app authors.

?website : string

⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ || The app's website.

?iconPath : string

⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ || Path to the app's icon in a JPEG or PNG file format. On Linux, will be shown as 64x64 pixels while retaining aspect ratio. On Windows, a 48x48 PNG will result in the best visual quality.

Returns: Options

Instance members

Instance member Description

this.applicationName

Full Usage: this.applicationName

The app's name.

this.applicationVersion

Full Usage: this.applicationVersion

The app's version.

this.authors

Full Usage: this.authors

⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ List of app authors.

this.copyright

Full Usage: this.copyright

Copyright information.

this.credits

Full Usage: this.credits

⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Credit information.

this.iconPath

Full Usage: this.iconPath

⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ Path to the app's icon in a JPEG or PNG file format. On Linux, will be shown as 64x64 pixels while retaining aspect ratio. On Windows, a 48x48 PNG will result in the best visual quality.

this.version

Full Usage: this.version

⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ The app's build version number.

this.website

Full Usage: this.website

⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ The app's website.

Type something to start searching.