---
layout: posts
title: Api - IChain Interface
---
<div class="container container-main toggle-visibilityprivate toggle-public">
<section class="tsd-panel tsd-comment">
	<div class="tsd-comment tsd-typography">
		<div class="lead">
			<p>A chain of paths which connect end to end.</p>
		</div>
	</div>
</section>
<section class="tsd-panel tsd-hierarchy">
	<h3>Hierarchy</h3>
	<ul class="tsd-hierarchy">
		<li>
			<span class="target">IChain</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="makerjs.ichain.html#contains" class="tsd-kind-icon">contains</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface"><a href="makerjs.ichain.html#endless" class="tsd-kind-icon">endless</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface"><a href="makerjs.ichain.html#links" class="tsd-kind-icon">links</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface"><a href="makerjs.ichain.html#pathlength" class="tsd-kind-icon">path<wbr>Length</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="contains" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> contains</h3>
		<div class="tsd-signature tsd-kind-icon">contains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IChain[]</span></div>
		<aside class="tsd-sources">
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/maker.ts#L705">src/maker.js/packages/maker.js/src/core/maker.ts:705</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Chains that are contained within this chain. Populated when chains are found with the &#39;contain&#39; option</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
		<a name="endless" class="tsd-anchor"></a>
		<h3>endless</h3>
		<div class="tsd-signature tsd-kind-icon">endless<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
		<aside class="tsd-sources">
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/maker.ts#L695">src/maker.js/packages/maker.js/src/core/maker.ts:695</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Flag if this chain forms a loop end to end.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
		<a name="links" class="tsd-anchor"></a>
		<h3>links</h3>
		<div class="tsd-signature tsd-kind-icon">links<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IChainLink[]</span></div>
		<aside class="tsd-sources">
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/maker.ts#L690">src/maker.js/packages/maker.js/src/core/maker.ts:690</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>The links in this chain.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
		<a name="pathlength" class="tsd-anchor"></a>
		<h3>path<wbr>Length</h3>
		<div class="tsd-signature tsd-kind-icon">path<wbr>Length<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/microsoft/maker.js/blob/master/packages/maker.js/src/core/maker.ts#L700">src/maker.js/packages/maker.js/src/core/maker.ts:700</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Total length of all paths in the chain.</p>
			</div>
		</div>
	</section>
</section>
</div>
<footer class="tsd-panel 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.io" target="_blank">TypeDoc</a></p>
</div>