ts-simple-ast
Version:
TypeScript compiler wrapper for AST navigation and code generation.
190 lines (152 loc) • 11.9 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 - Namespaces</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=""><a href="/details/interfaces">Interfaces</a></li>
<li class="active"><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="namespaces">Namespaces</h2>
<p>Namespaces (or modules) can be retrieved from source files or other namespaces:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">namespaces</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getNamespaces</span><span class="p">();</span>
<span class="kd">const</span> <span class="nx">namespace1</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getNamespace</span><span class="p">(</span><span class="s2">"Namespace1"</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">firstNamespaceWithClass</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getNamespace</span><span class="p">(</span><span class="nx">n</span> <span class="o">=></span> <span class="nx">n</span><span class="p">.</span><span class="nx">getClasses</span><span class="p">().</span><span class="nx">length</span> <span class="o">></span> <span class="mi">0</span><span class="p">);</span>
</code></pre>
</div>
<p>Most of the information you can get about namespaces is covered in other sections.</p>
<p>Note: Although it’s a compile error, you can also retreive namespaces from function bodies.</p>
<h3 id="addinsert">Add/Insert</h3>
<p>Add or insert namespaces to a source file, namespace, or function like declarations by calling <code class="highlighter-rouge">addNamespace()</code>, <code class="highlighter-rouge">addNamespaces()</code>, <code class="highlighter-rouge">insertNamespace()</code>, or <code class="highlighter-rouge">insertNamespaces()</code>.</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">namespaceDeclaration</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">addNamespace</span><span class="p">({</span>
<span class="na">name</span><span class="p">:</span> <span class="s2">"NamespaceName"</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">namespaceDeclaration</span><span class="p">.</span><span class="nx">remove</span><span class="p">();</span>
</code></pre>
</div>
<h3 id="module-or-namespace">Module or namespace?</h3>
<p>Check for the keyword you want:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">namespaceDeclaration</span><span class="p">.</span><span class="nx">hasModuleKeyword</span><span class="p">();</span> <span class="c1">// returns: boolean</span>
<span class="nx">namespaceDeclaration</span><span class="p">.</span><span class="nx">hasNamespaceKeyword</span><span class="p">();</span> <span class="c1">// returns: boolean</span>
</code></pre>
</div>
<p>Or set one or the other:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">namespaceDeclaration</span><span class="p">.</span><span class="nx">setHasModuleKeyword</span><span class="p">();</span> <span class="c1">// optionally pass in a boolean</span>
<span class="nx">namespaceDeclaration</span><span class="p">.</span><span class="nx">setHasNamespaceKeyword</span><span class="p">();</span>
</code></pre>
</div>
<p>Or get the keyword:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">namespaceDeclaration</span><span class="p">.</span><span class="nx">getDeclarationTypeKeyword</span><span class="p">();</span> <span class="c1">// returns: the module or namespace keyword</span>
</code></pre>
</div>
<h3 id="unwrap">Unwrap</h3>
<p>A namespace declaration can be replaced with its body using the <code class="highlighter-rouge">.unwrap()</code> method.</p>
<p>Given the following code:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="k">namespace</span> <span class="nx">MyNamespace</span> <span class="p">{</span>
<span class="kd">function</span> <span class="nx">someFunction</span><span class="p">()</span> <span class="p">{</span>
<span class="p">}</span>
<span class="kr">class</span> <span class="nx">SomeClass</span> <span class="p">{</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
</div>
<p>Calling <code class="highlighter-rouge">.unwrap()</code> on the namespace will change the code to the following:</p>
<div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">function</span> <span class="nx">someFunction</span><span class="p">()</span> <span class="p">{</span>
<span class="p">}</span>
<span class="kr">class</span> <span class="nx">SomeClass</span> <span class="p">{</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>