mirror of
https://github.com/kou029w/megabit.git
synced 2025-01-31 06:08:03 +00:00
575 lines
36 KiB
HTML
575 lines
36 KiB
HTML
|
<!doctype html>
|
||
|
<html class="default no-js">
|
||
|
<head>
|
||
|
<meta charset="utf-8">
|
||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
<title>I2CPortMap | megabit</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">megabit</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="i2cportmap.html">I2CPortMap</a>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<h1>Class I2CPortMap</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>Different from Web I2C API specification.</p>
|
||
|
</div>
|
||
|
</div>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-hierarchy">
|
||
|
<h3>Hierarchy</h3>
|
||
|
<ul class="tsd-hierarchy">
|
||
|
<li>
|
||
|
<a href="i2cportmap.html#map" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">></span>
|
||
|
<ul class="tsd-hierarchy">
|
||
|
<li>
|
||
|
<span class="target">I2CPortMap</span>
|
||
|
</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 tsd-is-external">
|
||
|
<h3>Properties</h3>
|
||
|
<ul class="tsd-index-list">
|
||
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#size" class="tsd-kind-icon">size</a></li>
|
||
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="i2cportmap.html#map" class="tsd-kind-icon">Map</a></li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="tsd-index-section tsd-is-external">
|
||
|
<h3>Methods</h3>
|
||
|
<ul class="tsd-index-list">
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#_symbol_iterator_" class="tsd-kind-icon">[<wbr>Symbol.iterator]</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#clear" class="tsd-kind-icon">clear</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#delete" class="tsd-kind-icon">delete</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#entries" class="tsd-kind-icon">entries</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#get" class="tsd-kind-icon">get</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="i2cportmap.html#getbyname" class="tsd-kind-icon">get<wbr>ByName</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#has" class="tsd-kind-icon">has</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#keys" class="tsd-kind-icon">keys</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#set" class="tsd-kind-icon">set</a></li>
|
||
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="i2cportmap.html#values" class="tsd-kind-icon">values</a></li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
</div>
|
||
|
</section>
|
||
|
</section>
|
||
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
||
|
<h2>Properties</h2>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||
|
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||
|
<div class="tsd-signature tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#_symbol_tostringtag_">[Symbol.toStringTag]</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a name="size" class="tsd-anchor"></a>
|
||
|
<h3>size</h3>
|
||
|
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#size">size</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
||
|
<a name="map" class="tsd-anchor"></a>
|
||
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> Map</h3>
|
||
|
<div class="tsd-signature tsd-kind-icon">Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MapConstructor</span></div>
|
||
|
<aside class="tsd-sources">
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
</section>
|
||
|
</section>
|
||
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
||
|
<h2>Methods</h2>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a name="_symbol_iterator_" class="tsd-anchor"></a>
|
||
|
<h3>[<wbr>Symbol.iterator]</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">[<wbr>Symbol.iterator]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#_symbol_iterator_">[Symbol.iterator]</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<div class="tsd-comment tsd-typography">
|
||
|
<div class="lead">
|
||
|
<p>Returns an iterable of entries in the map.</p>
|
||
|
</div>
|
||
|
</div>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">]</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-is-inherited tsd-is-external">
|
||
|
<a name="clear" class="tsd-anchor"></a>
|
||
|
<h3>clear</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</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">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#clear">clear</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:22</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<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 tsd-is-inherited tsd-is-external">
|
||
|
<a name="delete" class="tsd-anchor"></a>
|
||
|
<h3>delete</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><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">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#delete">delete</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li>
|
||
|
<h5>key: <a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a></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-inherited tsd-is-external">
|
||
|
<a name="entries" class="tsd-anchor"></a>
|
||
|
<h3>entries</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">entries<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#entries">entries</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<div class="tsd-comment tsd-typography">
|
||
|
<div class="lead">
|
||
|
<p>Returns an iterable of key, value pairs for every entry in the map.</p>
|
||
|
</div>
|
||
|
</div>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">]</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-is-inherited tsd-is-external">
|
||
|
<a name="foreach" class="tsd-anchor"></a>
|
||
|
<h3>for<wbr>Each</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>callbackfn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a>, key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a>, map<span class="tsd-signature-symbol">: </span><a href="i2cportmap.html#map" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, thisArg<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">void</span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#foreach">forEach</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li>
|
||
|
<h5>callbackfn: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a>, key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a>, map<span class="tsd-signature-symbol">: </span><a href="i2cportmap.html#map" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li class="tsd-parameter-siganture">
|
||
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a>, key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a>, map<span class="tsd-signature-symbol">: </span><a href="i2cportmap.html#map" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">></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>value: <a href="i2cport.html" class="tsd-signature-type">I2CPort</a></h5>
|
||
|
</li>
|
||
|
<li>
|
||
|
<h5>key: <a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a></h5>
|
||
|
</li>
|
||
|
<li>
|
||
|
<h5>map: <a href="i2cportmap.html#map" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">, </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">></span></h5>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
<li>
|
||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArg: <span class="tsd-signature-type">any</span></h5>
|
||
|
</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 tsd-is-inherited tsd-is-external">
|
||
|
<a name="get" class="tsd-anchor"></a>
|
||
|
<h3>get</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#get">get</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li>
|
||
|
<h5>key: <a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a></h5>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<h4 class="tsd-returns-title">Returns <a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
||
|
<a name="getbyname" class="tsd-anchor"></a>
|
||
|
<h3>get<wbr>ByName</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">get<wbr>ByName<span class="tsd-signature-symbol">(</span>portName<span class="tsd-signature-symbol">: </span><a href="../globals.html#portname" class="tsd-signature-type">PortName</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/node-web-i2c/index.ts:32</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li>
|
||
|
<h5>portName: <a href="../globals.html#portname" class="tsd-signature-type">PortName</a></h5>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a></h4>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a name="has" class="tsd-anchor"></a>
|
||
|
<h3>has</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">has<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><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">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#has">has</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li>
|
||
|
<h5>key: <a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a></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-inherited tsd-is-external">
|
||
|
<a name="keys" class="tsd-anchor"></a>
|
||
|
<h3>keys</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<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">IterableIterator</span><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">></span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#keys">keys</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<div class="tsd-comment tsd-typography">
|
||
|
<div class="lead">
|
||
|
<p>Returns an iterable of keys in the map</p>
|
||
|
</div>
|
||
|
</div>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a><span class="tsd-signature-symbol">></span></h4>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a name="set" class="tsd-anchor"></a>
|
||
|
<h3>set</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a>, value<span class="tsd-signature-symbol">: </span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#set">set</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
<ul class="tsd-parameters">
|
||
|
<li>
|
||
|
<h5>key: <a href="../globals.html#portnumber" class="tsd-signature-type">PortNumber</a></h5>
|
||
|
</li>
|
||
|
<li>
|
||
|
<h5>value: <a href="i2cport.html" class="tsd-signature-type">I2CPort</a></h5>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a name="values" class="tsd-anchor"></a>
|
||
|
<h3>values</h3>
|
||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<li class="tsd-signature tsd-kind-icon">values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><span class="tsd-signature-symbol">></span></li>
|
||
|
</ul>
|
||
|
<ul class="tsd-descriptions">
|
||
|
<li class="tsd-description">
|
||
|
<aside class="tsd-sources">
|
||
|
<p>Inherited from <a href="i2cportmap.html">I2CPortMap</a>.<a href="i2cportmap.html#values">values</a></p>
|
||
|
<ul>
|
||
|
<li>Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136</li>
|
||
|
</ul>
|
||
|
</aside>
|
||
|
<div class="tsd-comment tsd-typography">
|
||
|
<div class="lead">
|
||
|
<p>Returns an iterable of values in the map</p>
|
||
|
</div>
|
||
|
</div>
|
||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><a href="i2cport.html" class="tsd-signature-type">I2CPort</a><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">
|
||
|
</ul>
|
||
|
<ul class="current">
|
||
|
<li class="current tsd-kind-class tsd-is-external">
|
||
|
<a href="i2cportmap.html" class="tsd-kind-icon">I2CPort<wbr>Map</a>
|
||
|
<ul>
|
||
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#size" class="tsd-kind-icon">size</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
||
|
<a href="i2cportmap.html#map" class="tsd-kind-icon">Map</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#_symbol_iterator_" class="tsd-kind-icon">[<wbr>Symbol.iterator]</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#clear" class="tsd-kind-icon">clear</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#delete" class="tsd-kind-icon">delete</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#entries" class="tsd-kind-icon">entries</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#foreach" class="tsd-kind-icon">for<wbr>Each</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#get" class="tsd-kind-icon">get</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
||
|
<a href="i2cportmap.html#getbyname" class="tsd-kind-icon">get<wbr>ByName</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#has" class="tsd-kind-icon">has</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#keys" class="tsd-kind-icon">keys</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#set" class="tsd-kind-icon">set</a>
|
||
|
</li>
|
||
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
||
|
<a href="i2cportmap.html#values" class="tsd-kind-icon">values</a>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<ul class="after-current">
|
||
|
</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>
|