Skip to main content

Interface: FileAssociation

File associations.

macOS (corresponds to CFBundleDocumentTypes), NSIS, and MSI only.

On Windows (NSIS) works only if nsis.perMachine is set to true.

Properties​

description?​

readonly optional description?: string | null

windows-only. The description.

ext​

readonly ext: string | string[]

The extension (minus the leading period). e.g. png.

icon?​

readonly optional icon?: string | null

The path to icon (.icns for MacOS and .ico for Windows), relative to build (build resources directory). Defaults to ${firstExt}.icns/${firstExt}.ico (if several extensions specified, first is used) or to application icon.

Not supported on Linux, file issue if need (default icon will be x-office-document). Not supported on MSI.

isPackage?​

readonly optional isPackage?: boolean

macOS-only Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to LSTypeIsPackage.

mimeType?​

readonly optional mimeType?: string | null

linux-only. The mime-type.

name?​

readonly optional name?: string | null

The name. e.g. PNG. Defaults to ext.

rank?​

readonly optional rank?: string

macOS-only The app’s rank with respect to the type. The value can be Owner, Default, Alternate, or None. Corresponds to LSHandlerRank.

Default​

Default

role?​

readonly optional role?: string

macOS-only The app’s role with respect to the type. The value can be Editor, Viewer, Shell, or None. Corresponds to CFBundleTypeRole.

Default​

Editor