UNPKG

2.33 kBTypeScriptView Raw
1import { TargetSpecificOptions } from "../core";
2export interface AppXOptions extends TargetSpecificOptions {
3 /**
4 * The application id. Defaults to `identityName`. Can’t start with numbers.
5 */
6 readonly applicationId?: string;
7 /**
8 * The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).
9 * @default #464646
10 */
11 readonly backgroundColor?: string | null;
12 /**
13 * A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
14 * Defaults to the application product name.
15 */
16 readonly displayName?: string | null;
17 /**
18 * The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).
19 */
20 readonly identityName?: string | null;
21 /**
22 * The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.
23 */
24 readonly publisher?: string | null;
25 /**
26 * A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
27 * Defaults to company name from the application metadata.
28 */
29 readonly publisherDisplayName?: string | null;
30 /**
31 * The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.
32 * The first entry (index 0) will be the default language.
33 * Defaults to en-US if omitted.
34 */
35 readonly languages?: Array<string> | string | null;
36 /**
37 * Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.
38 */
39 readonly addAutoLaunchExtension?: boolean;
40 /**
41 * @private
42 * @default false
43 */
44 readonly electronUpdaterAware?: boolean;
45 /** @private */
46 readonly makeappxArgs?: Array<string> | null;
47}