This commit is contained in:
Brendan Forster
2017-09-18 10:54:18 +10:00
parent ffbd04b577
commit da0d364109

View File

@@ -1,4 +1,4 @@
// Type definitions for electron-winstaller 2.6.3
// Type definitions for electron-winstaller 2.6
// Project: https://github.com/electron/windows-installer
// Definitions by: Brendan Forster <https://github.com/shiftkey>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,111 +7,109 @@ export function convertVersion(version: string): string;
export function createWindowsInstaller(options: Options): Promise<void>;
type Options = {
export interface Options {
/**
* The folder path of your Electron app
*/
appDirectory: string,
appDirectory: string;
/**
* The folder path to create the .exe installer in.
*
* Defaults to the installer folder at the project root.
*/
outputDirectory?: string,
outputDirectory?: string;
/**
* The local path to a `.gif` file to display during install.
*/
loadingGif?: string,
loadingGif?: string;
/**
* The authors value for the nuget package metadata.
*
* Defaults to the `author` field from your app's package.json file when unspecified.
*/
authors: string,
authors: string;
/**
* The owners value for the nuget package metadata.
*
* Defaults to the `authors` field when unspecified.
*/
owners?: string,
owners?: string;
/**
* The name of your app's main `.exe` file.
*
* This uses the `name` field in your app's package.json file with an added `.exe` extension when unspecified.
*/
exe?: string,
exe?: string;
/**
* The description value for the nuget package metadata.
*
* Defaults to the `description` field from your app's package.json file when unspecified.
*/
description?: string,
description?: string;
/**
* The version value for the nuget package metadata.
*
* Defaults to the `version` field from your app's package.json file when unspecified.
*/
version?: string,
version?: string;
/**
* The title value for the nuget package metadata.
*
* Defaults to the `productName` field and then the `name` field from your app's package.json file when unspecified.
*/
title?: string,
title?: string;
/**
* Windows Application Model ID (appId).
*
* Defaults to the name field in your app's package.json file.
*/
name?: string,
name?: string;
/**
* The path to an Authenticode Code Signing Certificate
*/
certificateFile?: string,
certificateFile?: string;
/**
* The password to decrypt the certificate given in `certificateFile`
*/
certificatePassword?: string
certificatePassword?: string;
/**
* Params to pass to signtool.
*
* Overrides `certificateFile` and `certificatePassword`.
*/
signWithParams?: string,
signWithParams?: string;
/**
* A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features).
*
* Defaults to the Atom icon.
*/
iconUrl?: string,
iconUrl?: string;
/**
* The ICO file to use as the icon for the generated Setup.exe
*/
setupIcon?: string,
setupIcon?: string;
/**
* The name to use for the generated Setup.exe file
*/
setupExe?: string,
setupExe?: string;
/**
* The name to use for the generated Setup.msi file
*/
setupMsi?: string,
setupMsi?: string;
/**
* Should Squirrel.Windows create an MSI installer?
*/
noMsi?: boolean,
noMsi?: boolean;
/**
* Should Squirrel.Windows delta packages? (disable only if necessary, they are a Good Thing)
*/
noDelta?: boolean
noDelta?: boolean;
/**
* A URL to your existing updates. If given, these will be downloaded to create delta updates
*/
remoteReleases?: string,
remoteReleases?: string;
/**
* Authentication token for remote updates
*/
remoteToken?: string
remoteToken?: string;
}