Zum Hauptinhalt springen

CreateInstallerModuleOptions

CreateInstallerModuleOptions = object

Properties​

message?​

optional message: string

Message to include in the InstallerResult

Default​

"Executing steps"

saveStepOnFailure?​

optional saveStepOnFailure: boolean

Whether to save the last failed step ID after which the next installation attempt should resume

Default​

true

submitFileChangesFor?​

optional submitFileChangesFor: FileTypeName[]

A list of file types for which changes should be submitted after installation, only runs if installation is successful

Default​

undefined

preInstallAction()?​

optional preInstallAction: (options) => void

A callback function to be executed before installation begins, whether resuming or starting fresh

Parameters​

options​

InstallStepInputOptions

Returns​

void

Default​

undefined

postInstallAction()?​

optional postInstallAction: (options) => void

A callback function to be executed after installation, regardless of success or failure

Parameters​

options​

InstallStepInputOptions

Returns​

void

Default​

undefined

asUser?​

optional asUser: string

The user to execute the installation as

Default​

undefined