@electron-forge/maker-base 6.0.0-beta.9 → 6.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Maker.d.ts +31 -7
- package/dist/Maker.d.ts.map +1 -0
- package/dist/Maker.js +99 -111
- package/index.ts +5 -0
- package/package.json +9 -10
- package/tsconfig.json +34 -21
- package/doc/assets/css/main.css +0 -865
- package/doc/assets/css/main.css.map +0 -7
- package/doc/assets/images/icons.png +0 -0
- package/doc/assets/images/icons@2x.png +0 -0
- package/doc/assets/images/widgets.png +0 -0
- package/doc/assets/images/widgets@2x.png +0 -0
- package/doc/assets/js/main.js +0 -5
- package/doc/assets/js/search.js +0 -3
- package/doc/classes/maker.html +0 -484
- package/doc/globals.html +0 -168
- package/doc/index.html +0 -237
- package/doc/interfaces/makeroptions.html +0 -315
- package/src/Maker.ts +0 -123
- package/test/ensure-output_spec.ts +0 -56
- package/tslint.json +0 -12
package/doc/classes/maker.html
DELETED
|
@@ -1,484 +0,0 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<html class="default no-js">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>Maker | @electron-forge/maker-base</title>
|
|
7
|
-
<meta name="description" content="">
|
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
-
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
-
</head>
|
|
11
|
-
<body>
|
|
12
|
-
<header>
|
|
13
|
-
<div class="tsd-page-toolbar">
|
|
14
|
-
<div class="container">
|
|
15
|
-
<div class="table-wrap">
|
|
16
|
-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
17
|
-
<div class="field">
|
|
18
|
-
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
-
<input id="tsd-search-field" type="text" />
|
|
20
|
-
</div>
|
|
21
|
-
<ul class="results">
|
|
22
|
-
<li class="state loading">Preparing search index...</li>
|
|
23
|
-
<li class="state failure">The search index is not available</li>
|
|
24
|
-
</ul>
|
|
25
|
-
<a href="../index.html" class="title">@electron-forge/maker-base</a>
|
|
26
|
-
</div>
|
|
27
|
-
<div class="table-cell" id="tsd-widgets">
|
|
28
|
-
<div id="tsd-filter">
|
|
29
|
-
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
-
<div class="tsd-filter-group">
|
|
31
|
-
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
-
<span class="tsd-select-label">All</span>
|
|
33
|
-
<ul class="tsd-select-list">
|
|
34
|
-
<li data-value="public">Public</li>
|
|
35
|
-
<li data-value="protected">Public/Protected</li>
|
|
36
|
-
<li data-value="private" class="selected">All</li>
|
|
37
|
-
</ul>
|
|
38
|
-
</div>
|
|
39
|
-
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
-
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
-
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
42
|
-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
43
|
-
</div>
|
|
44
|
-
</div>
|
|
45
|
-
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
46
|
-
</div>
|
|
47
|
-
</div>
|
|
48
|
-
</div>
|
|
49
|
-
</div>
|
|
50
|
-
<div class="tsd-page-title">
|
|
51
|
-
<div class="container">
|
|
52
|
-
<ul class="tsd-breadcrumb">
|
|
53
|
-
<li>
|
|
54
|
-
<a href="../globals.html">Globals</a>
|
|
55
|
-
</li>
|
|
56
|
-
<li>
|
|
57
|
-
<a href="maker.html">Maker</a>
|
|
58
|
-
</li>
|
|
59
|
-
</ul>
|
|
60
|
-
<h1>Class Maker<C></h1>
|
|
61
|
-
</div>
|
|
62
|
-
</div>
|
|
63
|
-
</header>
|
|
64
|
-
<div class="container container-main">
|
|
65
|
-
<div class="row">
|
|
66
|
-
<div class="col-8 col-content">
|
|
67
|
-
<section class="tsd-panel tsd-type-parameters">
|
|
68
|
-
<h3>Type parameters</h3>
|
|
69
|
-
<ul class="tsd-type-parameters">
|
|
70
|
-
<li>
|
|
71
|
-
<h4>C</h4>
|
|
72
|
-
</li>
|
|
73
|
-
</ul>
|
|
74
|
-
</section>
|
|
75
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
76
|
-
<h3>Hierarchy</h3>
|
|
77
|
-
<ul class="tsd-hierarchy">
|
|
78
|
-
<li>
|
|
79
|
-
<span class="target">Maker</span>
|
|
80
|
-
</li>
|
|
81
|
-
</ul>
|
|
82
|
-
</section>
|
|
83
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
84
|
-
<h2>Index</h2>
|
|
85
|
-
<section class="tsd-panel tsd-index-panel">
|
|
86
|
-
<div class="tsd-index-content">
|
|
87
|
-
<section class="tsd-index-section ">
|
|
88
|
-
<h3>Constructors</h3>
|
|
89
|
-
<ul class="tsd-index-list">
|
|
90
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="maker.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
91
|
-
</ul>
|
|
92
|
-
</section>
|
|
93
|
-
<section class="tsd-index-section ">
|
|
94
|
-
<h3>Properties</h3>
|
|
95
|
-
<ul class="tsd-index-list">
|
|
96
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="maker.html#__iselectronforgemaker" class="tsd-kind-icon">__is<wbr>Electron<wbr>Forge<wbr>Maker</a></li>
|
|
97
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="maker.html#config" class="tsd-kind-icon">config</a></li>
|
|
98
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="maker.html#defaultplatforms" class="tsd-kind-icon">default<wbr>Platforms</a></li>
|
|
99
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="maker.html#name" class="tsd-kind-icon">name</a></li>
|
|
100
|
-
</ul>
|
|
101
|
-
</section>
|
|
102
|
-
<section class="tsd-index-section ">
|
|
103
|
-
<h3>Accessors</h3>
|
|
104
|
-
<ul class="tsd-index-list">
|
|
105
|
-
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="maker.html#platforms" class="tsd-kind-icon">platforms</a></li>
|
|
106
|
-
</ul>
|
|
107
|
-
</section>
|
|
108
|
-
<section class="tsd-index-section ">
|
|
109
|
-
<h3>Methods</h3>
|
|
110
|
-
<ul class="tsd-index-list">
|
|
111
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="maker.html#ensuredirectory" class="tsd-kind-icon">ensure<wbr>Directory</a></li>
|
|
112
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="maker.html#ensurefile" class="tsd-kind-icon">ensure<wbr>File</a></li>
|
|
113
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="maker.html#isinstalled" class="tsd-kind-icon">is<wbr>Installed</a></li>
|
|
114
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="maker.html#issupportedoncurrentplatform" class="tsd-kind-icon">is<wbr>Supported<wbr>OnCurrent<wbr>Platform</a></li>
|
|
115
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="maker.html#make" class="tsd-kind-icon">make</a></li>
|
|
116
|
-
</ul>
|
|
117
|
-
</section>
|
|
118
|
-
</div>
|
|
119
|
-
</section>
|
|
120
|
-
</section>
|
|
121
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
122
|
-
<h2>Constructors</h2>
|
|
123
|
-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
124
|
-
<a name="constructor" class="tsd-anchor"></a>
|
|
125
|
-
<h3>constructor</h3>
|
|
126
|
-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
127
|
-
<li class="tsd-signature tsd-kind-icon">new <wbr>Maker<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">C</span>, providedPlatforms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ForgePlatform</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="maker.html" class="tsd-signature-type">Maker</a></li>
|
|
128
|
-
</ul>
|
|
129
|
-
<ul class="tsd-descriptions">
|
|
130
|
-
<li class="tsd-description">
|
|
131
|
-
<aside class="tsd-sources">
|
|
132
|
-
<ul>
|
|
133
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L43">Maker.ts:43</a></li>
|
|
134
|
-
</ul>
|
|
135
|
-
</aside>
|
|
136
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
137
|
-
<ul class="tsd-parameters">
|
|
138
|
-
<li>
|
|
139
|
-
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> config: <span class="tsd-signature-type">C</span><span class="tsd-signature-symbol"> = {} as C</span></h5>
|
|
140
|
-
</li>
|
|
141
|
-
<li>
|
|
142
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> providedPlatforms: <span class="tsd-signature-type">ForgePlatform</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
143
|
-
</li>
|
|
144
|
-
</ul>
|
|
145
|
-
<h4 class="tsd-returns-title">Returns <a href="maker.html" class="tsd-signature-type">Maker</a></h4>
|
|
146
|
-
</li>
|
|
147
|
-
</ul>
|
|
148
|
-
</section>
|
|
149
|
-
</section>
|
|
150
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
151
|
-
<h2>Properties</h2>
|
|
152
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
153
|
-
<a name="__iselectronforgemaker" class="tsd-anchor"></a>
|
|
154
|
-
<h3>__is<wbr>Electron<wbr>Forge<wbr>Maker</h3>
|
|
155
|
-
<div class="tsd-signature tsd-kind-icon">__is<wbr>Electron<wbr>Forge<wbr>Maker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span></div>
|
|
156
|
-
<aside class="tsd-sources">
|
|
157
|
-
<ul>
|
|
158
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L43">Maker.ts:43</a></li>
|
|
159
|
-
</ul>
|
|
160
|
-
</aside>
|
|
161
|
-
</section>
|
|
162
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
163
|
-
<a name="config" class="tsd-anchor"></a>
|
|
164
|
-
<h3>config</h3>
|
|
165
|
-
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">C</span></div>
|
|
166
|
-
<aside class="tsd-sources">
|
|
167
|
-
<ul>
|
|
168
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L46">Maker.ts:46</a></li>
|
|
169
|
-
</ul>
|
|
170
|
-
</aside>
|
|
171
|
-
</section>
|
|
172
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
173
|
-
<a name="defaultplatforms" class="tsd-anchor"></a>
|
|
174
|
-
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> default<wbr>Platforms</h3>
|
|
175
|
-
<div class="tsd-signature tsd-kind-icon">default<wbr>Platforms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ForgePlatform</span><span class="tsd-signature-symbol">[]</span></div>
|
|
176
|
-
<aside class="tsd-sources">
|
|
177
|
-
<ul>
|
|
178
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L41">Maker.ts:41</a></li>
|
|
179
|
-
</ul>
|
|
180
|
-
</aside>
|
|
181
|
-
</section>
|
|
182
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
183
|
-
<a name="name" class="tsd-anchor"></a>
|
|
184
|
-
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> name</h3>
|
|
185
|
-
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
186
|
-
<aside class="tsd-sources">
|
|
187
|
-
<ul>
|
|
188
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L40">Maker.ts:40</a></li>
|
|
189
|
-
</ul>
|
|
190
|
-
</aside>
|
|
191
|
-
</section>
|
|
192
|
-
</section>
|
|
193
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
194
|
-
<h2>Accessors</h2>
|
|
195
|
-
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
196
|
-
<a name="platforms" class="tsd-anchor"></a>
|
|
197
|
-
<h3>platforms</h3>
|
|
198
|
-
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
|
199
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> platforms<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">"darwin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mas"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"win32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"linux"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></li>
|
|
200
|
-
</ul>
|
|
201
|
-
<ul class="tsd-descriptions">
|
|
202
|
-
<li class="tsd-description">
|
|
203
|
-
<aside class="tsd-sources">
|
|
204
|
-
<ul>
|
|
205
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L54">Maker.ts:54</a></li>
|
|
206
|
-
</ul>
|
|
207
|
-
</aside>
|
|
208
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">"darwin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mas"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"win32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"linux"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
209
|
-
</li>
|
|
210
|
-
</ul>
|
|
211
|
-
</section>
|
|
212
|
-
</section>
|
|
213
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
214
|
-
<h2>Methods</h2>
|
|
215
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
216
|
-
<a name="ensuredirectory" class="tsd-anchor"></a>
|
|
217
|
-
<h3>ensure<wbr>Directory</h3>
|
|
218
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
219
|
-
<li class="tsd-signature tsd-kind-icon">ensure<wbr>Directory<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
220
|
-
</ul>
|
|
221
|
-
<ul class="tsd-descriptions">
|
|
222
|
-
<li class="tsd-description">
|
|
223
|
-
<aside class="tsd-sources">
|
|
224
|
-
<ul>
|
|
225
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L91">Maker.ts:91</a></li>
|
|
226
|
-
</ul>
|
|
227
|
-
</aside>
|
|
228
|
-
<div class="tsd-comment tsd-typography">
|
|
229
|
-
<div class="lead">
|
|
230
|
-
<p>Ensures the directory exists and is forced to be empty.</p>
|
|
231
|
-
</div>
|
|
232
|
-
<p>I.e. If the directory already exists it is deleted and recreated, this
|
|
233
|
-
is a destructive operation</p>
|
|
234
|
-
</div>
|
|
235
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
236
|
-
<ul class="tsd-parameters">
|
|
237
|
-
<li>
|
|
238
|
-
<h5>dir: <span class="tsd-signature-type">string</span></h5>
|
|
239
|
-
</li>
|
|
240
|
-
</ul>
|
|
241
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
242
|
-
</li>
|
|
243
|
-
</ul>
|
|
244
|
-
</section>
|
|
245
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
246
|
-
<a name="ensurefile" class="tsd-anchor"></a>
|
|
247
|
-
<h3>ensure<wbr>File</h3>
|
|
248
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
249
|
-
<li class="tsd-signature tsd-kind-icon">ensure<wbr>File<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
250
|
-
</ul>
|
|
251
|
-
<ul class="tsd-descriptions">
|
|
252
|
-
<li class="tsd-description">
|
|
253
|
-
<aside class="tsd-sources">
|
|
254
|
-
<ul>
|
|
255
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L103">Maker.ts:103</a></li>
|
|
256
|
-
</ul>
|
|
257
|
-
</aside>
|
|
258
|
-
<div class="tsd-comment tsd-typography">
|
|
259
|
-
<div class="lead">
|
|
260
|
-
<p>Ensures the path to the file exists and the file does not exist</p>
|
|
261
|
-
</div>
|
|
262
|
-
<p>I.e. If the file already exists it is deleted and the path created</p>
|
|
263
|
-
</div>
|
|
264
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
265
|
-
<ul class="tsd-parameters">
|
|
266
|
-
<li>
|
|
267
|
-
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
|
268
|
-
</li>
|
|
269
|
-
</ul>
|
|
270
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
271
|
-
</li>
|
|
272
|
-
</ul>
|
|
273
|
-
</section>
|
|
274
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
275
|
-
<a name="isinstalled" class="tsd-anchor"></a>
|
|
276
|
-
<h3>is<wbr>Installed</h3>
|
|
277
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
278
|
-
<li class="tsd-signature tsd-kind-icon">is<wbr>Installed<span class="tsd-signature-symbol">(</span>module<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
279
|
-
</ul>
|
|
280
|
-
<ul class="tsd-descriptions">
|
|
281
|
-
<li class="tsd-description">
|
|
282
|
-
<aside class="tsd-sources">
|
|
283
|
-
<ul>
|
|
284
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L114">Maker.ts:114</a></li>
|
|
285
|
-
</ul>
|
|
286
|
-
</aside>
|
|
287
|
-
<div class="tsd-comment tsd-typography">
|
|
288
|
-
<div class="lead">
|
|
289
|
-
<p>Checks if the given module is installed, used for testing if optional dependencies
|
|
290
|
-
are installed or not</p>
|
|
291
|
-
</div>
|
|
292
|
-
</div>
|
|
293
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
294
|
-
<ul class="tsd-parameters">
|
|
295
|
-
<li>
|
|
296
|
-
<h5>module: <span class="tsd-signature-type">string</span></h5>
|
|
297
|
-
</li>
|
|
298
|
-
</ul>
|
|
299
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
300
|
-
</li>
|
|
301
|
-
</ul>
|
|
302
|
-
</section>
|
|
303
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
304
|
-
<a name="issupportedoncurrentplatform" class="tsd-anchor"></a>
|
|
305
|
-
<h3>is<wbr>Supported<wbr>OnCurrent<wbr>Platform</h3>
|
|
306
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
307
|
-
<li class="tsd-signature tsd-kind-icon">is<wbr>Supported<wbr>OnCurrent<wbr>Platform<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
308
|
-
</ul>
|
|
309
|
-
<ul class="tsd-descriptions">
|
|
310
|
-
<li class="tsd-description">
|
|
311
|
-
<aside class="tsd-sources">
|
|
312
|
-
<ul>
|
|
313
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L68">Maker.ts:68</a></li>
|
|
314
|
-
</ul>
|
|
315
|
-
</aside>
|
|
316
|
-
<div class="tsd-comment tsd-typography">
|
|
317
|
-
<div class="lead">
|
|
318
|
-
<p>Makers must implement this method and return true or false indicating whether
|
|
319
|
-
this maker can be run on the current platform. Normally this is just a process.platform
|
|
320
|
-
check but it can be a deeper check for dependencies like fake-root or other
|
|
321
|
-
required external build tools.</p>
|
|
322
|
-
</div>
|
|
323
|
-
<p>If the issue is a missing dependency you should log out a HELPFUL error message
|
|
324
|
-
telling the developer exactly what is missing and if possible how to get it.</p>
|
|
325
|
-
</div>
|
|
326
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
327
|
-
</li>
|
|
328
|
-
</ul>
|
|
329
|
-
</section>
|
|
330
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
331
|
-
<a name="make" class="tsd-anchor"></a>
|
|
332
|
-
<h3>make</h3>
|
|
333
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
334
|
-
<li class="tsd-signature tsd-kind-icon">make<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="../interfaces/makeroptions.html" class="tsd-signature-type">MakerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
335
|
-
</ul>
|
|
336
|
-
<ul class="tsd-descriptions">
|
|
337
|
-
<li class="tsd-description">
|
|
338
|
-
<aside class="tsd-sources">
|
|
339
|
-
<ul>
|
|
340
|
-
<li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/maker/base/src/Maker.ts#L76">Maker.ts:76</a></li>
|
|
341
|
-
</ul>
|
|
342
|
-
</aside>
|
|
343
|
-
<div class="tsd-comment tsd-typography">
|
|
344
|
-
<div class="lead">
|
|
345
|
-
<p>Makers must implement this method and return an array of absolute paths
|
|
346
|
-
to the artifacts generated by your maker</p>
|
|
347
|
-
</div>
|
|
348
|
-
</div>
|
|
349
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
350
|
-
<ul class="tsd-parameters">
|
|
351
|
-
<li>
|
|
352
|
-
<h5>opts: <a href="../interfaces/makeroptions.html" class="tsd-signature-type">MakerOptions</a></h5>
|
|
353
|
-
</li>
|
|
354
|
-
</ul>
|
|
355
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
356
|
-
</li>
|
|
357
|
-
</ul>
|
|
358
|
-
</section>
|
|
359
|
-
</section>
|
|
360
|
-
</div>
|
|
361
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
362
|
-
<nav class="tsd-navigation primary">
|
|
363
|
-
<ul>
|
|
364
|
-
<li class="globals ">
|
|
365
|
-
<a href="../globals.html"><em>Globals</em></a>
|
|
366
|
-
</li>
|
|
367
|
-
</ul>
|
|
368
|
-
</nav>
|
|
369
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
370
|
-
<ul class="before-current">
|
|
371
|
-
</ul>
|
|
372
|
-
<ul class="current">
|
|
373
|
-
<li class="current tsd-kind-class tsd-has-type-parameter">
|
|
374
|
-
<a href="maker.html" class="tsd-kind-icon">Maker</a>
|
|
375
|
-
<ul>
|
|
376
|
-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
377
|
-
<a href="maker.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
378
|
-
</li>
|
|
379
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
380
|
-
<a href="maker.html#__iselectronforgemaker" class="tsd-kind-icon">__is<wbr>Electron<wbr>Forge<wbr>Maker</a>
|
|
381
|
-
</li>
|
|
382
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
383
|
-
<a href="maker.html#config" class="tsd-kind-icon">config</a>
|
|
384
|
-
</li>
|
|
385
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
386
|
-
<a href="maker.html#defaultplatforms" class="tsd-kind-icon">default<wbr>Platforms</a>
|
|
387
|
-
</li>
|
|
388
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
389
|
-
<a href="maker.html#name" class="tsd-kind-icon">name</a>
|
|
390
|
-
</li>
|
|
391
|
-
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
392
|
-
<a href="maker.html#platforms" class="tsd-kind-icon">platforms</a>
|
|
393
|
-
</li>
|
|
394
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
395
|
-
<a href="maker.html#ensuredirectory" class="tsd-kind-icon">ensure<wbr>Directory</a>
|
|
396
|
-
</li>
|
|
397
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
398
|
-
<a href="maker.html#ensurefile" class="tsd-kind-icon">ensure<wbr>File</a>
|
|
399
|
-
</li>
|
|
400
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
401
|
-
<a href="maker.html#isinstalled" class="tsd-kind-icon">is<wbr>Installed</a>
|
|
402
|
-
</li>
|
|
403
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
404
|
-
<a href="maker.html#issupportedoncurrentplatform" class="tsd-kind-icon">is<wbr>Supported<wbr>OnCurrent<wbr>Platform</a>
|
|
405
|
-
</li>
|
|
406
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
407
|
-
<a href="maker.html#make" class="tsd-kind-icon">make</a>
|
|
408
|
-
</li>
|
|
409
|
-
</ul>
|
|
410
|
-
</li>
|
|
411
|
-
</ul>
|
|
412
|
-
<ul class="after-current">
|
|
413
|
-
<li class=" tsd-kind-interface">
|
|
414
|
-
<a href="../interfaces/makeroptions.html" class="tsd-kind-icon">Maker<wbr>Options</a>
|
|
415
|
-
</li>
|
|
416
|
-
</ul>
|
|
417
|
-
</nav>
|
|
418
|
-
</div>
|
|
419
|
-
</div>
|
|
420
|
-
</div>
|
|
421
|
-
<footer>
|
|
422
|
-
<div class="container">
|
|
423
|
-
<h2>Legend</h2>
|
|
424
|
-
<div class="tsd-legend-group">
|
|
425
|
-
<ul class="tsd-legend">
|
|
426
|
-
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
427
|
-
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
428
|
-
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
429
|
-
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
430
|
-
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
431
|
-
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
432
|
-
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
433
|
-
</ul>
|
|
434
|
-
<ul class="tsd-legend">
|
|
435
|
-
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
436
|
-
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
437
|
-
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
438
|
-
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
439
|
-
</ul>
|
|
440
|
-
<ul class="tsd-legend">
|
|
441
|
-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
442
|
-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
443
|
-
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
444
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
445
|
-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
446
|
-
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
447
|
-
</ul>
|
|
448
|
-
<ul class="tsd-legend">
|
|
449
|
-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
450
|
-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
451
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
452
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
453
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
454
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
455
|
-
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
456
|
-
</ul>
|
|
457
|
-
<ul class="tsd-legend">
|
|
458
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
459
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
460
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
461
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
462
|
-
</ul>
|
|
463
|
-
<ul class="tsd-legend">
|
|
464
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
465
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
466
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
467
|
-
</ul>
|
|
468
|
-
<ul class="tsd-legend">
|
|
469
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
470
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
471
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
472
|
-
</ul>
|
|
473
|
-
<ul class="tsd-legend">
|
|
474
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
475
|
-
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
476
|
-
</ul>
|
|
477
|
-
</div>
|
|
478
|
-
</div>
|
|
479
|
-
</footer>
|
|
480
|
-
<div class="overlay"></div>
|
|
481
|
-
<script src="../assets/js/main.js"></script>
|
|
482
|
-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
483
|
-
</body>
|
|
484
|
-
</html>
|