standard-data-structures

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Option | 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> <li> <a href="option.html">Option</a> </li> </ul> <h1>Class Option<A></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"> <div class="lead"> <p>Used to represent an optional value</p> </div> </div> </section> <section class="tsd-panel tsd-type-parameters"> <h3>Type parameters</h3> <ul class="tsd-type-parameters"> <li> <h4>A</h4> </li> </ul> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Option</span> <ul class="tsd-hierarchy"> <li> <a href="some.html" class="tsd-signature-type">Some</a> </li> <li> <a href="none.html" class="tsd-signature-type">None</a> </li> </ul> </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-class"><a href="option.html#aseither" class="tsd-kind-icon">as<wbr>Either</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="option.html#isnone" class="tsd-kind-icon">is<wbr>None</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="option.html#issome" class="tsd-kind-icon">is<wbr>Some</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="option.html#chain" class="tsd-kind-icon">chain</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="option.html#fold" class="tsd-kind-icon">fold</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="option.html#getorelse" class="tsd-kind-icon">get<wbr>OrElse</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="option.html#map" class="tsd-kind-icon">map</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="option.html#fromeither" class="tsd-kind-icon">from<wbr>Either</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="option.html#isnone-1" class="tsd-kind-icon">is<wbr>None</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="option.html#issome-1" class="tsd-kind-icon">is<wbr>Some</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="option.html#none" class="tsd-kind-icon">none</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="option.html#some" class="tsd-kind-icon">some</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-class"> <a name="aseither" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> as<wbr>Either</h3> <div class="tsd-signature tsd-kind-icon">as<wbr>Either<span class="tsd-signature-symbol">:</span> <a href="either.html" class="tsd-signature-type">Either</a><span class="tsd-signature-symbol"><</span><a href="nosuchvalueexception.html" class="tsd-signature-type">NoSuchValueException</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/tusharmath/standard-data-structures/blob/bbcd0c5/src/immutable/option.ts#L55">src/immutable/option.ts:55</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Converts an <a href="option.html">Option</a> to an <a href="either.html">Either</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="isnone" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> is<wbr>None</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>None<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/tusharmath/standard-data-structures/blob/bbcd0c5/src/immutable/option.ts#L60">src/immutable/option.ts:60</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns <code>true</code> if the instance is <a href="none.html">None</a></p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="issome" class="tsd-anchor"></a> <h3>is<wbr>Some</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isSome<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> </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/option.ts#L13">src/immutable/option.ts:13</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns <code>true</code> if the instance is <a href="some.html">Some</a></p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="chain" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> chain</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">chain<B><span class="tsd-signature-symbol">(</span>ab<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</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/option.ts#L65">src/immutable/option.ts:65</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Flattens the <a href="option.html">Option</a> type</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>B</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ab: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><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><a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <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 <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="fold" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> fold</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">fold<S><span class="tsd-signature-symbol">(</span>S<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, FN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</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/option.ts#L72">src/immutable/option.ts:72</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Takes a seed <code>S</code> value and applies the FN if this is <a href="some.html">Some</a> Returns the seed <code>S</code> if this is <a href="none.html">None</a></p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>S</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>S: <span class="tsd-signature-type">S</span></h5> </li> <li> <h5>FN: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span>, s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>r: <span class="tsd-signature-type">A</span></h5> </li> <li> <h5>s: <span class="tsd-signature-type">S</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">S</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">S</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getorelse" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>OrElse</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>OrElse<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/immutable/option.ts#L78">src/immutable/option.ts:78</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the real value if this is of <a href="some.html">Some</a> type. If its not a <a href="some.html">Some</a> type it returns the provided value.</p> </div> </div> <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-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="map" class="tsd-anchor"></a> <h3>map</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">map<B><span class="tsd-signature-symbol">(</span>ab<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</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/option.ts#L83">src/immutable/option.ts:83</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Transforms the value inside the <a href="option.html">Option</a> type.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>B</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ab: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><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">B</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <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">B</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a name="fromeither" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Either</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <li class="tsd-signature tsd-kind-icon">from<wbr>Either<L, R><span class="tsd-signature-symbol">(</span>either<span class="tsd-signature-symbol">: </span><a href="either.html" class="tsd-signature-type">Either</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">L</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</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/option.ts#L20">src/immutable/option.ts:20</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates an <a href="option.html">Option</a> from an <a href="either.html">Either</a></p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>L</h4> </li> <li> <h4>R</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>either: <a href="either.html" class="tsd-signature-type">Either</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">L</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a name="isnone-1" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>None</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>None<A><span class="tsd-signature-symbol">(</span>A<span class="tsd-signature-symbol">: </span><a href="option.html" class="tsd-signature-type">Option</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-symbol">: </span><span class="tsd-signature-type">boolean</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/option.ts#L27">src/immutable/option.ts:27</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Checks if the Option type is of <a href="none.html">None</a> type</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: <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a name="issome-1" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Some</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>Some<A><span class="tsd-signature-symbol">(</span>A<span class="tsd-signature-symbol">: </span><a href="option.html" class="tsd-signature-type">Option</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-symbol">: </span><span class="tsd-signature-type">boolean</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/option.ts#L34">src/immutable/option.ts:34</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Checks if the Option type is of <a href="some.html">Some</a> type</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: <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="none" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> none</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">none<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</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/option.ts#L41">src/immutable/option.ts:41</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates a <a href="none.html">None</a> object</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a name="some" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> some</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <li class="tsd-signature tsd-kind-icon">some<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><a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</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/option.ts#L48">src/immutable/option.ts:48</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates a <a href="some.html">Some</a> object</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 <a href="option.html" class="tsd-signature-type">Option</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</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 "> <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="doublylinkedlist.html" class="tsd-kind-icon">Doubly<wbr>Linked<wbr>List</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="either.html" class="tsd-kind-icon">Either</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="hashmap.html" class="tsd-kind-icon">Hash<wbr>Map</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="left.html" class="tsd-kind-icon">Left</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="linkedlistnode.html" class="tsd-kind-icon">Linked<wbr>List<wbr>Node</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="list.html" class="tsd-kind-icon">List</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="maxheap.html" class="tsd-kind-icon">Max<wbr>Heap</a> </li> <li class=" tsd-kind-class"> <a href="nosuchvalueexception.html" class="tsd-kind-icon">No<wbr>Such<wbr>Value<wbr>Exception</a> </li> <li class=" tsd-kind-class"> <a href="none.html" class="tsd-kind-icon">None</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-has-type-parameter"> <a href="option.html" class="tsd-kind-icon">Option</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="option.html#aseither" class="tsd-kind-icon">as<wbr>Either</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="option.html#isnone" class="tsd-kind-icon">is<wbr>None</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="option.html#issome" class="tsd-kind-icon">is<wbr>Some</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="option.html#chain" class="tsd-kind-icon">chain</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="option.html#fold" class="tsd-kind-icon">fold</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="option.html#getorelse" class="tsd-kind-icon">get<wbr>OrElse</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="option.html#map" class="tsd-kind-icon">map</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a href="option.html#fromeither" class="tsd-kind-icon">from<wbr>Either</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a href="option.html#isnone-1" class="tsd-kind-icon">is<wbr>None</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a href="option.html#issome-1" class="tsd-kind-icon">is<wbr>Some</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="option.html#none" class="tsd-kind-icon">none</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"> <a href="option.html#some" class="tsd-kind-icon">some</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="right.html" class="tsd-kind-icon">Right</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="some.html" class="tsd-kind-icon">Some</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="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>