docs(types): more updates

plumelo · Mar 16, 2020 · 2c9acfd · 2c9acfd
1 parent c2481df
commit 2c9acfd
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 44 deletions.
diff --git a/docs/globals.html b/docs/globals.html
@@ -3264,7 +3264,7 @@ <h3>Modules<wbr>Options</h3>
 				<div class="tsd-signature tsd-kind-icon">Modules<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>exportGlobals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ScopeOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"exportGlobals"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>failOnWrongOrder<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ExtractImportsOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"failOnWrongOrder"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>generateScopedName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ScopeOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"generateScopedName"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>getJSON<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, json<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, out<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LocalByDefaultOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"mode"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> }</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L174">src/types.ts:174</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L176">src/types.ts:176</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">

diff --git a/docs/index.html b/docs/index.html
@@ -3265,7 +3265,7 @@ <h3>Modules<wbr>Options</h3>
 				<div class="tsd-signature tsd-kind-icon">Modules<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>exportGlobals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ScopeOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"exportGlobals"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>failOnWrongOrder<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ExtractImportsOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"failOnWrongOrder"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>generateScopedName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ScopeOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"generateScopedName"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>getJSON<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, json<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, out<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LocalByDefaultOptions</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"mode"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> }</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L174">src/types.ts:174</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L176">src/types.ts:176</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/extracteddata.html b/docs/interfaces/extracteddata.html
@@ -2786,7 +2786,7 @@ <h3>code</h3>
 				<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L164">src/types.ts:164</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L166">src/types.ts:166</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2801,7 +2801,7 @@ <h3>code<wbr>File<wbr>Name</h3>
 				<div class="tsd-signature tsd-kind-icon">code<wbr>File<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L166">src/types.ts:166</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L168">src/types.ts:168</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2816,7 +2816,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> map</h3>
 				<div class="tsd-signature tsd-kind-icon">map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L168">src/types.ts:168</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L170">src/types.ts:170</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2831,7 +2831,7 @@ <h3>map<wbr>File<wbr>Name</h3>
 				<div class="tsd-signature tsd-kind-icon">map<wbr>File<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L170">src/types.ts:170</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L172">src/types.ts:172</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/loader.html b/docs/interfaces/loader.html
@@ -2759,6 +2759,11 @@ <h3>Type parameters</h3>
 			<ul class="tsd-type-parameters">
 				<li>
 					<h4>LoaderOptionsType</h4>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>type of loader&#39;s options</p>
+						</div>
+					</div>
 				</li>
 			</ul>
 		</section>
@@ -2794,7 +2799,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Process</h
 				<div class="tsd-signature tsd-kind-icon">always<wbr>Process<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L114">src/types.ts:114</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L117">src/types.ts:117</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2809,7 +2814,7 @@ <h3>name</h3>
 				<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L107">src/types.ts:107</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L110">src/types.ts:110</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2824,7 +2829,7 @@ <h3>process</h3>
 				<div class="tsd-signature tsd-kind-icon">process<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><a href="loadercontext.html" class="tsd-signature-type">LoaderContext</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">LoaderOptionsType</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><a href="payload.html" class="tsd-signature-type">Payload</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="payload.html" class="tsd-signature-type">Payload</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="payload.html" class="tsd-signature-type">Payload</a></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L116">src/types.ts:116</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L119">src/types.ts:119</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2863,7 +2868,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> test</h3>
 				<div class="tsd-signature tsd-kind-icon">test<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>filepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L112">src/types.ts:112</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L115">src/types.ts:115</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/loadercontext.html b/docs/interfaces/loadercontext.html
@@ -2768,6 +2768,11 @@ <h3>Type parameters</h3>
 			<ul class="tsd-type-parameters">
 				<li>
 					<h4>LoaderOptionsType</h4>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>type of loader&#39;s options</p>
+						</div>
+					</div>
 				</li>
 			</ul>
 		</section>
@@ -2806,7 +2811,7 @@ <h3>dependencies</h3>
 				<div class="tsd-signature tsd-kind-icon">dependencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L133">src/types.ts:133</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L137">src/types.ts:137</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2821,7 +2826,7 @@ <h3>error</h3>
 				<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PluginContext</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol">]</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L137">src/types.ts:137</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L141">src/types.ts:141</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2836,7 +2841,7 @@ <h3>id</h3>
 				<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L131">src/types.ts:131</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L135">src/types.ts:135</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2851,7 +2856,7 @@ <h3>options</h3>
 				<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LoaderOptionsType</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L127">src/types.ts:127</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L131">src/types.ts:131</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2871,7 +2876,7 @@ <h3>plugin</h3>
 				<div class="tsd-signature tsd-kind-icon">plugin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PluginContext</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L139">src/types.ts:139</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L143">src/types.ts:143</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2886,7 +2891,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> source<wbr>Map</h3>
 				<div class="tsd-signature tsd-kind-icon">source<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inline"</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L129">src/types.ts:129</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L133">src/types.ts:133</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2903,7 +2908,7 @@ <h3>warn</h3>
 				<div class="tsd-signature tsd-kind-icon">warn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PluginContext</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"warn"</span><span class="tsd-signature-symbol">]</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L135">src/types.ts:135</a></li>
+						<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L139">src/types.ts:139</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">