ts-simple-ast
Version:
TypeScript compiler wrapper for AST navigation and code generation.
205 lines (158 loc) • 12.9 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>TsSimpleAst</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/css/bootstrap.min.css" integrity="sha384-rwoIResjU2yc3z8GV/NPeZWAv56rSmLldC3R/AZzGRnGxQQKnKkoFVhFQhNUwEyJ" crossorigin="anonymous">
<link rel="stylesheet" href="/assets/css/style.css?v=71a391c40e7283d83416a246f2c61c5fcb76068a">
<!--
<link rel="stylesheet" href="/assets/css/style.css?v=71a391c40e7283d83416a246f2c61c5fcb76068a">
<link rel="stylesheet" href="/assets/css/custom-style.css?v=71a391c40e7283d83416a246f2c61c5fcb76068a">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script src="/assets/js/main.js"></script>-->
</head>
<body>
<div class="main">
<header class="container">
<div class="row">
<h1 onclick="document.location.href = '/'" class="headerLink">TsSimpleAst</h1>
<!--<p class="subText">Simple way to navigate and manipulate the TypeScript AST.</p>-->
</div>
</header>
<div class="container">
<div class="row">
<div class="col-md-3">
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<nav class="sidebar-nav" id="navbarSupportedContent">
<ul class="navbar-nav navbar-default">
<li class="nav-item">
<a class="nav-link" href="/">Overview</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/setup">Setup</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/navigation">Navigation</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/manipulation">Manipulation</a>
</li>
<li class="">
<a class="nav-link" href="/details/index">Details</a>
<ul>
<li class=""><a href="/details/source-files">Source Files</a></li>
<li class=""><a href="/details/classes">Classes</a></li>
<li class="active"><a href="/details/enums">Enums</a></li>
<li class=""><a href="/details/functions">Functions</a></li>
<li class=""><a href="/details/interfaces">Interfaces</a></li>
<li class=""><a href="/details/namespaces">Namespaces</a></li>
<li class=""><a href="/details/type-aliases">Type Aliases</a></li>
<li class=""><a href="/details/variables">Variables</a></li>
<li>--</li>
<li class=""><a href="/details/types">Types</a></li>
<li class=""><a href="/details/expressions">Expressions</a></li>
<li>--</li>
<li class=""><a href="/details/ambient">Ambient</a></li>
<li class=""><a href="/details/async">Async</a></li>
<li class=""><a href="/details/decorators">Decorators</a></li>
<li class=""><a href="/details/exports">Exports</a></li>
<li class=""><a href="/details/generators">Generators</a></li>
<li class=""><a href="/details/documentation">JS Docs</a></li>
<li class=""><a href="/details/modifiers">Modifiers</a></li>
</ul>
</li>
<li class="nav-item">
<a class="nav-link" href="http://github.com/dsherret/ts-simple-ast">View on GitHub</a>
</li>
</ul>
</nav>
</div>
<section class="container-fluid col-md-9">
<h2 id="enums">Enums</h2>
<p>Enums can be retrieved from source files, namespaces, or function bodies:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">enums</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getEnums</span><span class="p">();</span>
<span class="kd">const</span> <span class="nx">enum1</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getEnum</span><span class="p">(</span><span class="s2">"Enum1"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">enum2</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getEnum</span><span class="p">(</span><span class="nx">e</span> <span class="o">=></span> <span class="nx">e</span><span class="p">.</span><span class="nx">getMembers</span><span class="p">().</span><span class="nx">length</span> <span class="o">===</span> <span class="mi">5</span><span class="p">);</span>
</code></pre>
</div>
<h3 id="adding">Adding</h3>
<p>You can add enums to a source file or namespace by calling <code class="highlighter-rouge">addEnum()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">enumDeclaration</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">addEnum</span><span class="p">({</span>
<span class="na">name</span><span class="p">:</span> <span class="s2">"EnumName"</span><span class="p">,</span>
<span class="na">members</span><span class="p">:</span> <span class="p">[{</span>
<span class="na">name</span><span class="p">:</span> <span class="s2">"member"</span>
<span class="p">}]</span>
<span class="p">});</span>
</code></pre>
</div>
<h3 id="add-member">Add member</h3>
<p>Members can be added by calling <code class="highlighter-rouge">addMember()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">member</span> <span class="o">=</span> <span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">addMember</span><span class="p">({</span>
<span class="na">name</span><span class="p">:</span> <span class="s2">"newMember"</span><span class="p">,</span>
<span class="na">value</span><span class="p">:</span> <span class="mi">10</span>
<span class="p">});</span>
</code></pre>
</div>
<h3 id="get-all-members">Get all members</h3>
<p>Use <code class="highlighter-rouge">getMembers()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">members</span> <span class="o">=</span> <span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">getMembers</span><span class="p">();</span>
</code></pre>
</div>
<h3 id="get-member">Get member</h3>
<p>Use <code class="highlighter-rouge">getMember()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">member1</span> <span class="o">=</span> <span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">getMember</span><span class="p">(</span><span class="s2">"member1"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">member2</span> <span class="o">=</span> <span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">getMember</span><span class="p">(</span><span class="nx">m</span> <span class="o">=></span> <span class="nx">m</span><span class="p">.</span><span class="nx">getValue</span><span class="p">()</span> <span class="o">===</span> <span class="mi">1</span><span class="p">);</span>
</code></pre>
</div>
<h3 id="const-enum">Const enum</h3>
<p>Check if it’s a const enum via <code class="highlighter-rouge">isConstEnum()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">isConstEnum</span><span class="p">();</span> <span class="c1">// returns: boolean</span>
</code></pre>
</div>
<p>Get the <code class="highlighter-rouge">const</code> keyword via <code class="highlighter-rouge">getConstKeyword()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">getConstKeyword</span><span class="p">();</span> <span class="c1">// returns: Node | undefined</span>
</code></pre>
</div>
<p>Set if it’s a const enum via <code class="highlighter-rouge">setIsConstEnum(value)</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">setIsConstEnum</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">setIsConstEnum</span><span class="p">(</span><span class="kc">false</span><span class="p">);</span>
</code></pre>
</div>
<h2 id="enum-members">Enum Members</h2>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">member</span> <span class="o">=</span> <span class="nx">enumDeclaration</span><span class="p">.</span><span class="nx">getMember</span><span class="p">(</span><span class="s2">"member"</span><span class="p">);</span>
</code></pre>
</div>
<h3 id="get-the-value">Get the value</h3>
<p>The value can be retrieved whether it is implicitly or explicitly defined:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">member</span><span class="p">.</span><span class="nx">getValue</span><span class="p">();</span> <span class="c1">// returns: number</span>
</code></pre>
</div>
<h3 id="following-comma">Following comma</h3>
<p>Enum members may have a comma after them. You can check for that via:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">member</span><span class="p">.</span><span class="nx">hasFollowingComma</span><span class="p">();</span> <span class="c1">// returns: boolean</span>
</code></pre>
</div>
<p>And get it via:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">member</span><span class="p">.</span><span class="nx">getFollowingComma</span><span class="p">();</span> <span class="c1">// returns: node | undefined</span>
</code></pre>
</div>
<h3 id="remove-a-member">Remove a Member</h3>
<p>Call <code class="highlighter-rouge">remove()</code> on it:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">member</span><span class="p">.</span><span class="nx">remove</span><span class="p">();</span>
</code></pre>
</div>
</section>
</div>
</div>
<footer>
</footer>
</div>
<script src="https://code.jquery.com/jquery-3.1.1.slim.min.js" integrity="sha384-A7FZj7v+d/sdmMqp/nOQwliLvUsJfDHW+k9Omg/a/EheAdgtzNs3hpfag6Ed950n" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js" integrity="sha384-DztdAPBWPRXSA/3eYEEUWrWCy7G5KFbe8fFjk5JAIxUYHKkDx6Qin1DkWx51bBrb" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
</body>
</html>