mutation-summary
Version:
Makes observing the DOM fast and easy
436 lines • 19.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NodeMap | mutation-summary</title>
<meta name="description" content="Documentation for mutation-summary">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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.json" 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">mutation-summary</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="../modules.html">mutation-summary</a>
</li>
<li>
<a href="nodemap.html">NodeMap</a>
</li>
</ul>
<h1>Class NodeMap<T></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>A helper class that maps from a DOM Node to an arbitrary value.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">NodeMap</span>
<ul class="tsd-hierarchy">
<li>
<a href="treechanges.html" class="tsd-signature-type" data-tsd-kind="Class">TreeChanges</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="nodemap.html#constructor" class="tsd-kind-icon">constructor</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"><a href="nodemap.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="nodemap.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="nodemap.html#has" class="tsd-kind-icon">has</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="nodemap.html#keys" class="tsd-kind-icon">keys</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="nodemap.html#set" class="tsd-kind-icon">set</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">new <wbr>Node<wbr>Map<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="nodemap.html" class="tsd-signature-type" data-tsd-kind="Class">NodeMap</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/convergencelabs/mutation-summary/blob/7c78d6f/src/NodeMap.ts#L21">NodeMap.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a new and empty NodeMap.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="nodemap.html" class="tsd-signature-type" data-tsd-kind="Class">NodeMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/convergencelabs/mutation-summary/blob/7c78d6f/src/NodeMap.ts#L70">NodeMap.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deletes a node from the NodeMap.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>node: <span class="tsd-signature-type">Node</span></h5>
<div class="tsd-comment tsd-typography">
<p>The node to delete.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="get" class="tsd-anchor"></a>
<h3>get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/convergencelabs/mutation-summary/blob/7c78d6f/src/NodeMap.ts#L49">NodeMap.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets the value for the given node.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>node: <span class="tsd-signature-type">Node</span></h5>
<div class="tsd-comment tsd-typography">
<p>The node to get the value of.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>The value for the given node, or undefined if the node is not
present in the map.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="has" class="tsd-anchor"></a>
<h3>has</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</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/convergencelabs/mutation-summary/blob/7c78d6f/src/NodeMap.ts#L61">NodeMap.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Determines if a given node is in the NodeMap.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>node: <span class="tsd-signature-type">Node</span></h5>
<div class="tsd-comment tsd-typography">
<p>The node to determine if it is in the map.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>true if the Node is contained in the map, false otherwise.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="keys" class="tsd-anchor"></a>
<h3>keys</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</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/convergencelabs/mutation-summary/blob/7c78d6f/src/NodeMap.ts#L79">NodeMap.ts:79</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol">[]</span></h4>
<p>an array that holds the nodes that are the keys of the map.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="set" class="tsd-anchor"></a>
<h3>set</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</span>, value<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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/convergencelabs/mutation-summary/blob/7c78d6f/src/NodeMap.ts#L36">NodeMap.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the value of a node within the map.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>node: <span class="tsd-signature-type">Node</span></h5>
<div class="tsd-comment tsd-typography">
<p>The node to set the value for.</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>the value to associate with the node.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/movement.html" class="tsd-kind-icon">Movement</a>
</li>
<li class=" tsd-kind-class">
<a href="childlistchange.html" class="tsd-kind-icon">Child<wbr>List<wbr>Change</a>
</li>
<li class=" tsd-kind-class">
<a href="mutationprojection.html" class="tsd-kind-icon">Mutation<wbr>Projection</a>
</li>
<li class=" tsd-kind-class">
<a href="mutationsummary.html" class="tsd-kind-icon">Mutation<wbr>Summary</a>
</li>
<li class=" tsd-kind-class">
<a href="nodechange.html" class="tsd-kind-icon">Node<wbr>Change</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="nodemap.html" class="tsd-kind-icon">Node<wbr>Map</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a href="nodemap.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="nodemap.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="nodemap.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="nodemap.html#has" class="tsd-kind-icon">has</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="nodemap.html#keys" class="tsd-kind-icon">keys</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="nodemap.html#set" class="tsd-kind-icon">set</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="qualifier.html" class="tsd-kind-icon">Qualifier</a>
</li>
<li class=" tsd-kind-class">
<a href="selector.html" class="tsd-kind-icon">Selector</a>
</li>
<li class=" tsd-kind-class">
<a href="summary.html" class="tsd-kind-icon">Summary</a>
</li>
<li class=" tsd-kind-class">
<a href="treechanges.html" class="tsd-kind-icon">Tree<wbr>Changes</a>
</li>
<li class=" tsd-kind-class">
<a href="treemirror.html" class="tsd-kind-icon">Tree<wbr>Mirror</a>
</li>
<li class=" tsd-kind-class">
<a href="treemirrorclient.html" class="tsd-kind-icon">Tree<wbr>Mirror<wbr>Client</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/iattributedata.html" class="tsd-kind-icon">IAttribute<wbr>Data</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/imutationsummaryoptions.html" class="tsd-kind-icon">IMutation<wbr>Summary<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/inodedata.html" class="tsd-kind-icon">INode<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/inumbermap.html" class="tsd-kind-icon">INumber<wbr>Map</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/ipositiondata.html" class="tsd-kind-icon">IPosition<wbr>Data</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/iquery.html" class="tsd-kind-icon">IQuery</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/iqueryvalidator.html" class="tsd-kind-icon">IQuery<wbr>Validator</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/istringmap.html" class="tsd-kind-icon">IString<wbr>Map</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/itextdata.html" class="tsd-kind-icon">IText<wbr>Data</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-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>
</ul>
<ul class="tsd-legend">
<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>
</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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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>
</body>
</html>