UNPKG

1.65 kBTypeScriptView Raw
1import { Configuration } from "../configuration";
2export interface Metadata {
3 /**
4 * The application name.
5 * @required
6 */
7 readonly name?: string;
8 /**
9 * The application description.
10 */
11 readonly description?: string;
12 /**
13 * The url to the project [homepage](https://docs.npmjs.com/files/package.json#homepage) (NuGet Package `projectUrl` (optional) or Linux Package URL (required)).
14 *
15 * If not specified and your project repository is public on GitHub, it will be `https://github.com/${user}/${project}` by default.
16 */
17 readonly homepage?: string | null;
18 /**
19 * *linux-only.* The [license](https://docs.npmjs.com/files/package.json#license) name.
20 */
21 readonly license?: string | null;
22 readonly author?: AuthorMetadata | null;
23 /**
24 * The [repository](https://docs.npmjs.com/files/package.json#repository).
25 */
26 readonly repository?: string | RepositoryInfo | null;
27 /**
28 * The electron-builder configuration.
29 */
30 readonly build?: Configuration;
31 /** @private */
32 readonly dependencies?: {
33 [key: string]: string;
34 };
35 /** @private */
36 readonly version?: string;
37 /** @private */
38 readonly type?: string;
39 /** @private */
40 readonly shortVersion?: string | null;
41 /** @private */
42 readonly shortVersionWindows?: string | null;
43 /** @private */
44 readonly productName?: string | null;
45 /** @private */
46 readonly main?: string | null;
47}
48export interface AuthorMetadata {
49 readonly name: string;
50 readonly email?: string;
51}
52export interface RepositoryInfo {
53 readonly url: string;
54}