cyclejs-utils

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"index" | cyclejs-utils</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">cyclejs-utils</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="_index_.html">"index"</a> </li> </ul> <h1>External module "index"</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>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_index_.html#intosignature" class="tsd-kind-icon">Into<wbr>Signature</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_index_.html#mergearguments" class="tsd-kind-icon">Merge<wbr>Arguments</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_index_.html#mergeexceptions" class="tsd-kind-icon">Merge<wbr>Exceptions</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_index_.html#mergeoneplus" class="tsd-kind-icon">Merge<wbr>One<wbr>Plus</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"><a href="_index_.html#mergetuplemembers" class="tsd-kind-icon">Merge<wbr>Tuple<wbr>Members</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_index_.html#pickmergeexceptions" class="tsd-kind-icon">Pick<wbr>Merge<wbr>Exceptions</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_index_.html#composelenses" class="tsd-kind-icon">compose<wbr>Lenses</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_index_.html#extractsinks" class="tsd-kind-icon">extract<wbr>Sinks</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_index_.html#loadasync" class="tsd-kind-icon">load<wbr>Async</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_index_.html#mergesinks" class="tsd-kind-icon">merge<wbr>Sinks</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_index_.html#pickmergesinks" class="tsd-kind-icon">pick<wbr>Merge<wbr>Sinks</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a name="intosignature" class="tsd-anchor"></a> <h3>Into<wbr>Signature</h3> <div class="tsd-signature tsd-kind-icon">Into<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L14">index.ts:14</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <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>args: <span class="tsd-signature-type">T</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a name="mergearguments" class="tsd-anchor"></a> <h3>Merge<wbr>Arguments</h3> <div class="tsd-signature tsd-kind-icon">Merge<wbr>Arguments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">{ [Key in K]: T extends (first: infer A) => void ? A : { [Key in K]: T extends (first: infer A, ...args: infer U) => void ? A & any[K] : never; }[K]; }[K]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L4">index.ts:4</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"> <a name="mergeexceptions" class="tsd-anchor"></a> <h3>Merge<wbr>Exceptions</h3> <div class="tsd-signature tsd-kind-icon">Merge<wbr>Exceptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L18">index.ts:18</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a name="mergeoneplus" class="tsd-anchor"></a> <h3>Merge<wbr>One<wbr>Plus</h3> <div class="tsd-signature tsd-kind-icon">Merge<wbr>One<wbr>Plus<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">{ [Key in K]: T extends (first: infer A, ...args: infer U) => void ? A & { [Key in K]: (...args: U) => void extends (first: infer A) => void ? A : any[K]; }[K] : never; }[K]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L8">index.ts:8</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a name="mergetuplemembers" class="tsd-anchor"></a> <h3>Merge<wbr>Tuple<wbr>Members</h3> <div class="tsd-signature tsd-kind-icon">Merge<wbr>Tuple<wbr>Members<span class="tsd-signature-symbol">:</span> <a href="_index_.html#mergearguments" class="tsd-signature-type">MergeArguments</a><span class="tsd-signature-symbol"><</span><a href="_index_.html#intosignature" class="tsd-signature-type">IntoSignature</a><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></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L16">index.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="pickmergeexceptions" class="tsd-anchor"></a> <h3>Pick<wbr>Merge<wbr>Exceptions</h3> <div class="tsd-signature tsd-kind-icon">Pick<wbr>Merge<wbr>Exceptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L73">index.ts:73</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><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>ins<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Instances</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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>ins: <span class="tsd-signature-type">Instances</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <a name="composelenses" class="tsd-anchor"></a> <h3>compose<wbr>Lenses</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">compose<wbr>Lenses<A, B, C><span class="tsd-signature-symbol">(</span>outer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Lens</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">></span>, inner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Lens</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Lens</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">C</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/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L148">index.ts:148</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Composes two lenses to one</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>A</h4> </li> <li> <h4>B</h4> </li> <li> <h4>C</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>outer: <span class="tsd-signature-type">Lens</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">></span></h5> </li> <li> <h5>inner: <span class="tsd-signature-type">Lens</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">B</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Lens</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span></h4> <p>composed lens</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <a name="extractsinks" class="tsd-anchor"></a> <h3>extract<wbr>Sinks</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">extract<wbr>Sinks<Si><span class="tsd-signature-symbol">(</span>sinks$<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Si</span><span class="tsd-signature-symbol">></span>, driverNames<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L106">index.ts:106</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Extracts the sinks from a Stream of Sinks</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>Si</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sinks$: <span class="tsd-signature-type">Stream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Si</span><span class="tsd-signature-symbol">></span></h5> </li> <li> <h5>driverNames: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>the names of all drivers that are possibly in the stream, it's best to use Object.keys() on your driver object</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <p>A sinks containing the streams of the last emission in the sinks$</p> <ul class="tsd-parameters"> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="loadasync" class="tsd-anchor"></a> <h3>load<wbr>Async</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">load<wbr>Async<span class="tsd-signature-symbol">(</span>moduleLoader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, driverNames<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L127">index.ts:127</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Can be used to load a component lazy (with webpack code splitting)</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>moduleLoader: <span class="tsd-signature-type">function</span></h5> <div class="tsd-comment tsd-typography"> <p>A function like <code>() => import('./myModule')</code></p> </div> <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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li> <h5>driverNames: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>The names of the drivers the lazy component uses</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "default"</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of the export. For loading a default export simply ignore</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4> <p>A dummy that loads the actual component</p> <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>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <a name="mergesinks" class="tsd-anchor"></a> <h3>merge<wbr>Sinks</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">merge<wbr>Sinks<T><span class="tsd-signature-symbol">(</span>sinks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, exceptions<span class="tsd-signature-symbol">?: </span><a href="_index_.html#mergeexceptions" class="tsd-signature-type">MergeExceptions</a><span class="tsd-signature-symbol"><</span><a href="_index_.html#mergetuplemembers" class="tsd-signature-type">MergeTupleMembers</a><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-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#mergetuplemembers" class="tsd-signature-type">MergeTupleMembers</a><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/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L26">index.ts:26</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Applies xs.merge to all sinks in the array</p> </div> </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-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">]</span></h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sinks: <span class="tsd-signature-type">T</span></h5> <div class="tsd-comment tsd-typography"> <p>the sinks to be merged</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> exceptions: <a href="_index_.html#mergeexceptions" class="tsd-signature-type">MergeExceptions</a><span class="tsd-signature-symbol"><</span><a href="_index_.html#mergetuplemembers" class="tsd-signature-type">MergeTupleMembers</a><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-symbol"> = {}</span></h5> <div class="tsd-comment tsd-typography"> <p>a dictionary of special channels, e.g. DOM</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_index_.html#mergetuplemembers" class="tsd-signature-type">MergeTupleMembers</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4> <p>the new unified sink</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="pickmergesinks" class="tsd-anchor"></a> <h3>pick<wbr>Merge<wbr>Sinks</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">pick<wbr>Merge<wbr>Sinks<span class="tsd-signature-symbol">(</span>driverNames<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, exceptions<span class="tsd-signature-symbol">?: </span><a href="_index_.html#pickmergeexceptions" class="tsd-signature-type">PickMergeExceptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-utils/blob/7fe81bb/src/index.ts#L81">index.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Just like mergeSinks, but for onionify collections</p> </div> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p>mergeSinks</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>driverNames: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> exceptions: <a href="_index_.html#pickmergeexceptions" class="tsd-signature-type">PickMergeExceptions</a><span class="tsd-signature-symbol"> = {}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4> <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>ins<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Instances</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ins: <span class="tsd-signature-type">Instances</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </li> </ul> </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> <li class="current tsd-kind-external-module"> <a href="_index_.html">"index"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a href="_index_.html#intosignature" class="tsd-kind-icon">Into<wbr>Signature</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a href="_index_.html#mergearguments" class="tsd-kind-icon">Merge<wbr>Arguments</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="_index_.html#mergeexceptions" class="tsd-kind-icon">Merge<wbr>Exceptions</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a href="_index_.html#mergeoneplus" class="tsd-kind-icon">Merge<wbr>One<wbr>Plus</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported"> <a href="_index_.html#mergetuplemembers" class="tsd-kind-icon">Merge<wbr>Tuple<wbr>Members</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_index_.html#pickmergeexceptions" class="tsd-kind-icon">Pick<wbr>Merge<wbr>Exceptions</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="_index_.html#composelenses" class="tsd-kind-icon">compose<wbr>Lenses</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="_index_.html#extractsinks" class="tsd-kind-icon">extract<wbr>Sinks</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_index_.html#loadasync" class="tsd-kind-icon">load<wbr>Async</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="_index_.html#mergesinks" class="tsd-kind-icon">merge<wbr>Sinks</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_index_.html#pickmergesinks" class="tsd-kind-icon">pick<wbr>Merge<wbr>Sinks</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>