UNPKG

@lcap/asl

Version:

NetEase Application Specific Language

248 lines 13.9 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>utils/traverse | @lcap/asl</title> <meta name="description" content="Documentation for @lcap/asl"> <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">@lcap/asl</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">@lcap/asl</a> </li> <li> <a href="utils_traverse.html">utils/traverse</a> </li> </ul> <h1>Module utils/traverse</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>References</h3> <ul class="tsd-index-list"> <li class="tsd-kind-reference tsd-parent-kind-module"><a href="utils_traverse.html#default" class="tsd-kind-icon">default</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/utils_traverse.inode.html" class="tsd-kind-icon">INode</a></li> <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-kind-icon">INode<wbr>Info</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-module tsd-has-type-parameter"><a href="utils_traverse.html#traverse" class="tsd-kind-icon">traverse</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>References</h2> <section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"> <a name="default" class="tsd-anchor"></a> <h3>default</h3> Renames and exports <a href="utils_traverse.html#traverse">traverse</a> </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-module tsd-has-type-parameter"> <a name="traverse" class="tsd-anchor"></a> <h3>traverse</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">traverse&lt;T&gt;<span class="tsd-signature-symbol">(</span>func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>current<span class="tsd-signature-symbol">: </span><a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">INodeInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span>, init<span class="tsd-signature-symbol">: </span><a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">INodeInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>depthFirst<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;onlyChildren&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;onlyArray&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;anyObject&quot;</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"> <aside class="tsd-sources"> <ul> <li>Defined in utils/traverse.ts:129</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>遍历树</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>traverse((current) =&gt; console.log(current.node.name), { init: rootNode });</p> </dd> <dt>example</dt> <dd><p>traverse((current) =&gt; console.log(current.jsonPath), { init: ast }, { mode: &#39;anyObject&#39; });</p> </dd> </dl> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/utils_traverse.inode.html" class="tsd-signature-type" data-tsd-kind="Interface">INode</a></h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>func: <span class="tsd-signature-symbol">(</span>current<span class="tsd-signature-symbol">: </span><a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">INodeInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>current<span class="tsd-signature-symbol">: </span><a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">INodeInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</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>current: <a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">INodeInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>init: <a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">INodeInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5> <div class="tsd-comment tsd-typography"> <p>初始点信息</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>depthFirst<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;onlyChildren&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;onlyArray&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;anyObject&quot;</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> depth<wbr>First<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>默认广度优先搜索,是否深度优先搜索</p> </div> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;onlyChildren&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;onlyArray&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;anyObject&quot;</span></h5> <div class="tsd-comment tsd-typography"> <p>&#39;onlyChildren&#39; 表示只向下遍历 children 的元素(默认);&#39;onlyArray&#39; 表示只向下遍历 Array 的元素;&#39;anyObject&#39; 表示只要属性为 Object 类型都会遍历</p> </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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> <li class="current tsd-kind-module"> <a href="utils_traverse.html">utils/traverse</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-reference tsd-parent-kind-module"> <a href="utils_traverse.html#default" class="tsd-kind-icon">default</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/utils_traverse.inode.html" class="tsd-kind-icon">INode</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"> <a href="../interfaces/utils_traverse.inodeinfo.html" class="tsd-kind-icon">INode<wbr>Info</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"> <a href="utils_traverse.html#traverse" class="tsd-kind-icon">traverse</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-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-type-alias"><span class="tsd-kind-icon">Type alias</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> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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>