standard-data-structures
Version:
A collection of standard data-structures for node and browser
309 lines (308 loc) • 16.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>standard-data-structures</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">standard-data-structures</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>
</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>
</ul>
<h1> standard-data-structures</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/doublylinkedlist.html" class="tsd-kind-icon">Doubly<wbr>Linked<wbr>List</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/either.html" class="tsd-kind-icon">Either</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/hashmap.html" class="tsd-kind-icon">Hash<wbr>Map</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/left.html" class="tsd-kind-icon">Left</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/linkedlistnode.html" class="tsd-kind-icon">Linked<wbr>List<wbr>Node</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/list.html" class="tsd-kind-icon">List</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/maxheap.html" class="tsd-kind-icon">Max<wbr>Heap</a></li>
<li class="tsd-kind-class"><a href="classes/nosuchvalueexception.html" class="tsd-kind-icon">No<wbr>Such<wbr>Value<wbr>Exception</a></li>
<li class="tsd-kind-class"><a href="classes/none.html" class="tsd-kind-icon">None</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/option.html" class="tsd-kind-icon">Option</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/right.html" class="tsd-kind-icon">Right</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/some.html" class="tsd-kind-icon">Some</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/tuple.html" class="tsd-kind-icon">Tuple</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/icollection.html" class="tsd-kind-icon">ICollection</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#pipe" class="tsd-kind-icon">pipe</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> id</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">id<A><span class="tsd-signature-symbol">(</span>A<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/tusharmath/standard-data-structures/blob/bbcd0c5/src/internals/id.ts#L4">src/internals/id.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>ID function that takes in a value and returns the same value as output.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>A</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>A: <span class="tsd-signature-type">A</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">A</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="pipe" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> pipe</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">pipe<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PipelineN</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/tusharmath/standard-data-structures/blob/bbcd0c5/src/immutable/pipe.ts#L40">src/immutable/pipe.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Takes in any number of values that can be piped into a function.
Returns a pipeline that can be used recursively to pipe to other functions.</p>
</div>
<p><strong>Example:</strong></p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> {pipe} <span class="hljs-keyword">from</span> <span class="hljs-string">'standard-data-structures'</span>
pipe(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>).into(<span class="hljs-function">(<span class="hljs-params">A, B</span>) =></span> A + B).into(<span class="hljs-function"><span class="hljs-params">A</span> =></span> [A, A * A]).drain <span class="hljs-comment">// [3, 9]</span></code></pre>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>T: <span class="tsd-signature-type">T</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PipelineN</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals current ">
<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-class tsd-has-type-parameter">
<a href="classes/doublylinkedlist.html" class="tsd-kind-icon">Doubly<wbr>Linked<wbr>List</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/either.html" class="tsd-kind-icon">Either</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/hashmap.html" class="tsd-kind-icon">Hash<wbr>Map</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/left.html" class="tsd-kind-icon">Left</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/linkedlistnode.html" class="tsd-kind-icon">Linked<wbr>List<wbr>Node</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/list.html" class="tsd-kind-icon">List</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/maxheap.html" class="tsd-kind-icon">Max<wbr>Heap</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/nosuchvalueexception.html" class="tsd-kind-icon">No<wbr>Such<wbr>Value<wbr>Exception</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/none.html" class="tsd-kind-icon">None</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/option.html" class="tsd-kind-icon">Option</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/right.html" class="tsd-kind-icon">Right</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/some.html" class="tsd-kind-icon">Some</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/tuple.html" class="tsd-kind-icon">Tuple</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/icollection.html" class="tsd-kind-icon">ICollection</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#pipe" class="tsd-kind-icon">pipe</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>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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="https://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>