gulp-dotnet-cli
Version:
A dotnet command line interface for gulp
461 lines • 22.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>INugetPushModel | gulp-dotnet-cli</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">gulp-dotnet-cli</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="inugetpushmodel.html">INugetPushModel</a>
</li>
</ul>
<h1>Interface INugetPushModel</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>interface</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">INugetPushModel</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#apikey" class="tsd-kind-icon">api<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#disablebuffering" class="tsd-kind-icon">disable<wbr>Buffering</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#echo" class="tsd-kind-icon">echo</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#forceenglishoutput" class="tsd-kind-icon">force<wbr>English<wbr>Output</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#nosymbols" class="tsd-kind-icon">no<wbr>Symbols</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#source" class="tsd-kind-icon">source</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#symbolapikey" class="tsd-kind-icon">symbol<wbr>Api<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#symbolsource" class="tsd-kind-icon">symbolsource</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="inugetpushmodel.html#timeout" class="tsd-kind-icon">timeout</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="apikey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">api<wbr>Key<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/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L43">schema/interfaces/INugetPushModel.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The API key for the server.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="disablebuffering" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> disable<wbr>Buffering</h3>
<div class="tsd-signature tsd-kind-icon">disable<wbr>Buffering<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L57">schema/interfaces/INugetPushModel.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disable buffering when pushing to an HTTP(S) server to decrease memory usage.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="echo" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> echo</h3>
<div class="tsd-signature tsd-kind-icon">echo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L71">schema/interfaces/INugetPushModel.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logs the command we run to the console</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="forceenglishoutput" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> force<wbr>English<wbr>Output</h3>
<div class="tsd-signature tsd-kind-icon">force<wbr>English<wbr>Output<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L14">schema/interfaces/INugetPushModel.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nosymbols" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> no<wbr>Symbols</h3>
<div class="tsd-signature tsd-kind-icon">no<wbr>Symbols<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L64">schema/interfaces/INugetPushModel.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If a symbols package exists, it will not be pushed to a symbols server.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="source" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> source</h3>
<div class="tsd-signature tsd-kind-icon">source<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/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L21">schema/interfaces/INugetPushModel.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies the server URL</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="symbolapikey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> symbol<wbr>Api<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">symbol<wbr>Api<wbr>Key<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/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L50">schema/interfaces/INugetPushModel.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The API key for the symbol server.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="symbolsource" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> symbolsource</h3>
<div class="tsd-signature tsd-kind-icon">symbolsource<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/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L29">schema/interfaces/INugetPushModel.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies the symbol server URL. If not specified, nuget.smbsrc.net is used when pushing to nuget.org</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="timeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/INugetPushModel.ts#L36">schema/interfaces/INugetPushModel.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies the timeout for pushing to a server in seconds. Defaults to 300 seconds (5 minutes)</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{number}</p>
</dd>
<dt>memberof</dt>
<dd><p>INugetPushModel</p>
</dd>
</dl>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface">
<a href="ibuildmodel.html" class="tsd-kind-icon">IBuild<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="icleanmodel.html" class="tsd-kind-icon">IClean<wbr>Model</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="inugetpushmodel.html" class="tsd-kind-icon">INuget<wbr>Push<wbr>Model</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#apikey" class="tsd-kind-icon">api<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#disablebuffering" class="tsd-kind-icon">disable<wbr>Buffering</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#echo" class="tsd-kind-icon">echo</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#forceenglishoutput" class="tsd-kind-icon">force<wbr>English<wbr>Output</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#nosymbols" class="tsd-kind-icon">no<wbr>Symbols</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#source" class="tsd-kind-icon">source</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#symbolapikey" class="tsd-kind-icon">symbol<wbr>Api<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#symbolsource" class="tsd-kind-icon">symbolsource</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="inugetpushmodel.html#timeout" class="tsd-kind-icon">timeout</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="ipackmodel.html" class="tsd-kind-icon">IPack<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="ipublishmodel.html" class="tsd-kind-icon">IPublish<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="irestoremodel.html" class="tsd-kind-icon">IRestore<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="irunmodel.html" class="tsd-kind-icon">IRun<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="itestmodel.html" class="tsd-kind-icon">ITest<wbr>Model</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../globals.html#plugin_name" class="tsd-kind-icon">PLUGIN_<wbr>NAME</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#shelly" class="tsd-kind-icon">shelly</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>