ts-simple-ast
Version:
TypeScript compiler wrapper for AST navigation and code generation.
249 lines (190 loc) • 18.8 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>ts-simple-ast - Interfaces</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=502728dc7b09041e36b06c50f79a13adbfb6f1b2">
<!--
<link rel="stylesheet" href="/assets/css/style.css?v=502728dc7b09041e36b06c50f79a13adbfb6f1b2">
<link rel="stylesheet" href="/assets/css/custom-style.css?v=502728dc7b09041e36b06c50f79a13adbfb6f1b2">
<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">ts-simple-ast</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="nav-item">
<a class="nav-link" href="/emitting">Emitting</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=""><a href="/details/decorators">Decorators</a></li>
<li class=""><a href="/details/enums">Enums</a></li>
<li class=""><a href="/details/functions">Functions</a></li>
<li class=""><a href="/details/imports">Imports</a></li>
<li class="active"><a href="/details/interfaces">Interfaces</a></li>
<li class=""><a href="/details/namespaces">Namespaces</a></li>
<li class=""><a href="/details/parameters">Parameters</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/signatures">Signatures</a></li>
<li>--</li>
<li class=""><a href="/details/expressions">Expressions</a></li>
<li class=""><a href="/details/object-literal-expressions">Object Literal Expressions</a></li>
<li class=""><a href="/details/identifiers">Identifiers</a></li>
<li class=""><a href="/details/ambient">Ambient</a></li>
<li class=""><a href="/details/async">Async</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/initializers">Initializers</a></li>
<li class=""><a href="/details/documentation">JS Docs</a></li>
<li class=""><a href="/details/literals">Literals</a></li>
<li class=""><a href="/details/modifiers">Modifiers</a></li>
</ul>
</li>
<li class="nav-item">
<a class="nav-link" href="/utilities">Utilities</a>
</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="interface-declarations">Interface Declarations</h2>
<p>Interface declarations 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">interfaces</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getInterfaces</span><span class="p">();</span>
<span class="kd">const</span> <span class="nx">interface1</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getInterface</span><span class="p">(</span><span class="s2">"Interface1"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">firstInterfaceWith5Properties</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getInterface</span><span class="p">(</span><span class="nx">i</span> <span class="o">=></span> <span class="nx">i</span><span class="p">.</span><span class="nx">getProperties</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="addinsert">Add/Insert</h3>
<p>Add or insert interfaces to a source file, namespace, or function like declarations by calling <code class="highlighter-rouge">addInterface()</code>, <code class="highlighter-rouge">addInterfaces()</code>, <code class="highlighter-rouge">insertInterface()</code>, or <code class="highlighter-rouge">insertInterfaces()</code>.</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">interfaceDeclaration</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">addInterface</span><span class="p">({</span>
<span class="na">name</span><span class="p">:</span> <span class="s2">"InterfaceName"</span>
<span class="p">});</span>
</code></pre>
</div>
<h3 id="remove">Remove</h3>
<p>Call <code class="highlighter-rouge">.remove()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">remove</span><span class="p">();</span>
</code></pre>
</div>
<h3 id="extends-expressions">Extends expressions</h3>
<p>Will return <a href="expressions"><code class="highlighter-rouge">ExpressionWithTypeArguments[]</code></a>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">extendsExpressions</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getExtends</span><span class="p">();</span>
</code></pre>
</div>
<p>Add or insert extends expressions:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">addExtends</span><span class="p">(</span><span class="s2">"Named"</span><span class="p">);</span>
<span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">addExtends</span><span class="p">([</span><span class="s2">"Named"</span><span class="p">,</span> <span class="s2">"Aged"</span><span class="p">]);</span>
<span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">insertExtends</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"Named"</span><span class="p">);</span>
<span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">insertExtends</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="p">[</span><span class="s2">"Named"</span><span class="p">,</span> <span class="s2">"Aged"</span><span class="p">]);</span>
</code></pre>
</div>
<p>Remove an expression:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">removeExtends</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span> <span class="c1">// index</span>
<span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">removeExtends</span><span class="p">(</span><span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getExtends</span><span class="p">()[</span><span class="mi">0</span><span class="p">]);</span> <span class="c1">// node</span>
</code></pre>
</div>
<h3 id="construct-signatures">Construct signatures</h3>
<p>Use:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">constructSignatures</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getConstructSignatures</span><span class="p">();</span>
<span class="kd">const</span> <span class="nx">constructSignature</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getConstructSignature</span><span class="p">(</span><span class="nx">c</span> <span class="o">=></span> <span class="nx">c</span><span class="p">.</span><span class="nx">getParameters</span><span class="p">().</span><span class="nx">length</span> <span class="o">></span> <span class="mi">2</span><span class="p">);</span>
</code></pre>
</div>
<h4 id="addinsert-1">Add/Insert</h4>
<p>To add or insert use <code class="highlighter-rouge">addConstructSignature()</code>, <code class="highlighter-rouge">addConstructSignatures()</code>, <code class="highlighter-rouge">insertConstructSignature</code>, or <code class="highlighter-rouge">insertConstructSignatures()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">constructSignature</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">addConstructSignature</span><span class="p">({</span> <span class="na">returnType</span><span class="p">:</span> <span class="s2">"SomeClass"</span> <span class="p">});</span>
</code></pre>
</div>
<h4 id="remove-1">Remove</h4>
<p>Remove a construct signature:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">constructSignature</span><span class="p">.</span><span class="nx">remove</span><span class="p">();</span>
</code></pre>
</div>
<h3 id="method-signatures">Method signatures</h3>
<p>Use:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">methodSignatures</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getMethods</span><span class="p">();</span>
<span class="kd">const</span> <span class="nx">myMethod</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getMethod</span><span class="p">(</span><span class="s2">"myMethod"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">firstMethodWith4Params</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getMethod</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">getParameters</span><span class="p">().</span><span class="nx">length</span> <span class="o">===</span> <span class="mi">4</span><span class="p">);</span>
</code></pre>
</div>
<h4 id="addinsert-2">Add/Insert</h4>
<p>To add or insert use <code class="highlighter-rouge">addMethod()</code>, <code class="highlighter-rouge">addMethods()</code>, <code class="highlighter-rouge">insertMethod</code>, or <code class="highlighter-rouge">insertMethods()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">methodSignature</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">insertMethod</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="p">{</span> <span class="na">name</span><span class="p">:</span> <span class="s2">"newMethod"</span><span class="p">,</span> <span class="na">returnType</span><span class="p">:</span> <span class="s2">"boolean"</span> <span class="p">});</span>
</code></pre>
</div>
<h4 id="remove-2">Remove</h4>
<p>Remove a method signature:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">methodSignature</span><span class="p">.</span><span class="nx">remove</span><span class="p">();</span>
</code></pre>
</div>
<h3 id="properties">Properties</h3>
<p>Use:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">properties</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getProperties</span><span class="p">();</span>
<span class="kd">const</span> <span class="nx">myProperty</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getProperty</span><span class="p">(</span><span class="s2">"myProperty"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">firstStringProperty</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getProperty</span><span class="p">(</span><span class="nx">p</span> <span class="o">=></span> <span class="nx">p</span><span class="p">.</span><span class="nx">getType</span><span class="p">().</span><span class="nx">getText</span><span class="p">()</span> <span class="o">===</span> <span class="s2">"string"</span><span class="p">);</span>
</code></pre>
</div>
<h4 id="addinsert-3">Add/Insert</h4>
<p>To add or insert use <code class="highlighter-rouge">addProperty()</code>, <code class="highlighter-rouge">addProperties()</code>, <code class="highlighter-rouge">insertProperty</code>, or <code class="highlighter-rouge">insertProperties()</code>:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">propertySignature</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">insertProperty</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="p">{</span> <span class="na">name</span><span class="p">:</span> <span class="s2">"newProperty"</span><span class="p">,</span> <span class="na">type</span><span class="p">:</span> <span class="s2">"string"</span> <span class="p">});</span>
</code></pre>
</div>
<h4 id="remove-3">Remove</h4>
<p>Remove a property signature:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">propertySignature</span><span class="p">.</span><span class="nx">remove</span><span class="p">();</span>
</code></pre>
</div>
<h3 id="implementations">Implementations</h3>
<p>Get the implementations.</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">implementations</span> <span class="o">=</span> <span class="nx">interfaceDeclaration</span><span class="p">.</span><span class="nx">getImplementations</span><span class="p">();</span>
</code></pre>
</div>
<p>Similar to “go to implementation” command available in IDEs.</p>
</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>