forked from TypeScriptToLua/TypeScriptToLua.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
44 lines (44 loc) · 46.3 KB
/
index.html
File metadata and controls
44 lines (44 loc) · 46.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-alpha.70">
<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="TypeScriptToLua Blog RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="TypeScriptToLua Blog Atom Feed">
<link rel="search" type="application/opensearchdescription+xml" title="TypeScriptToLua" href="/opensearch.xml"><title data-react-helmet="true">Overview | TypeScriptToLua</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="current"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Overview | TypeScriptToLua"><meta data-react-helmet="true" name="description" content="High-level API"><meta data-react-helmet="true" property="og:description" content="High-level API"><meta data-react-helmet="true" property="og:url" content="https://typescripttolua.github.io/docs/api/overview"><link data-react-helmet="true" rel="shortcut icon" href="/images/favicon.ico"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link data-react-helmet="true" rel="canonical" href="https://typescripttolua.github.io/docs/api/overview"><link rel="stylesheet" href="/styles.dd4f4be3.css">
<link rel="stylesheet" href="/main.69618293.css">
<link rel="stylesheet" href="/1be78505.0edf629a.css">
<link rel="preload" href="/styles.9e960a30.js" as="script">
<link rel="preload" href="/runtime~main.a6dad94e.js" as="script">
<link rel="preload" href="/main.3eca3247.js" as="script">
<link rel="preload" href="/1.f61e14a0.js" as="script">
<link rel="preload" href="/3.25dbb900.js" as="script">
<link rel="preload" href="/1be78505.fd95f0c2.js" as="script">
<link rel="preload" href="/29.3d07cf4e.js" as="script">
<link rel="preload" href="/935f2afb.7b3a4519.js" as="script">
<link rel="preload" href="/25.3e7184fc.js" as="script">
<link rel="preload" href="/65df3d35.f779a28a.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_11B0">Skip to main content</button></nav><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">TypeScriptToLua</strong></a><a class="navbar__item navbar__link" href="/docs/getting-started">Docs</a><a class="navbar__item navbar__link" href="/play">Playground</a></div><div class="navbar__items navbar__items--right"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Discord</a><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2N3Q"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_3NWk">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_3NWk">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><div class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></div></button></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">TypeScriptToLua</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/play">Playground</a></li><li class="menu__list-item"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="menu__link">Discord</a></li><li class="menu__list-item"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_vMrn"><div class="docSidebarContainer_3Ak5" role="complementary"><div class="sidebar_3gvy"><div class="menu menu--responsive thin-scrollbar menu_1yIk"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_1CUI" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/configuration">Configuration</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/caveats">Caveats</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/the-self-parameter">The Self Parameter</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/editor-support">Editor Support</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Advanced</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/advanced/writing-declarations">Writing Declarations</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/advanced/compiler-annotations">Compiler Annotations</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/advanced/language-extensions">Language extensions</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">API</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/api/overview">Overview</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/api/plugins">Plugins</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/api/printer">Printer</a></li></ul></li></ul></div></div></div><main class="docMainContainer_2iGs"><div class="container padding-vert--lg docItemWrapper_1bxp"><div class="row"><div class="col docItemCol_U38p"><div class="docItemContainer_a7m4"><article><header><h1 class="docTitle_Oumm">Overview</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="high-level-api"></a>High-level API<a class="hash-link" href="#high-level-api" title="Direct link to heading">#</a></h2><p>The high level API allows you to simply invoke several common transpiler operations using well-known language primitives, handling usage of TypeScript API for you.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="transpilestring"></a>TranspileString<a class="hash-link" href="#transpilestring" title="Direct link to heading">#</a></h3><p>Transpile a string containing TypeScript source code to Lua.</p><p><strong>Arguments:</strong></p><ul><li>Source: string - The TypeScript source code to transpile.</li><li><em>[Optional]</em> Options: tstl.CompilerOptions - CompilerOptions to use.</li></ul><p><strong>Example:</strong></p><div class="mdxCodeBlock_1zKU"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a aria-label="Open code on playground" class="playgroundButton_3DKR" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xqmAbOAzKCEOAIhgE8wBTVAYymDBgFoYJnsBXZEgbgCh+tCADsscKDU7Z4AXgxZsAOhhRkYsMGxUAyquAiA5gAoABsLHw8ECHHkkARsih9TAGjgBvOF2QAVZ0MqGAAuBRwlABluAKggmCjuAFYAZjgAXwBKAQtUCG0lbAgTSVRpBIATYGRDEQgsYFpUbKFRPIKikqkZJTwtKmygA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> result </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">transpileString</span><span class="token punctuation" style="color:#393A34">(</span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token template-string string" style="color:#e3116c">const foo = "bar";</span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> luaTarget</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">LuaTarget</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Lua53</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">diagnostics</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">file</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="transpilefiles"></a>TranspileFiles<a class="hash-link" href="#transpilefiles" title="Direct link to heading">#</a></h3><p>Transpile a collection of TypeScript files to Lua.</p><p><strong>Arguments:</strong></p><ul><li>FileNames: string[] - An array of file paths to the TypeScript files to be transpiled.</li><li><em>[Optional]</em> Options: tstl.CompilerOptions - CompilerOptions to use.</li></ul><p><strong>Example:</strong></p><div class="mdxCodeBlock_1zKU"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a aria-label="Open code on playground" class="playgroundButton_3DKR" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xqmAbOAzKCEOAIhgE8wBTVAYymDBgFoYJnsBXZEgbgCh+tCADsscKDU7Z4AXgxZsAOhhRkYsMGxUAYlpoAKANok8+gIwrUJADSkz2gExWSAXTsBvOF2QAVZFAA5lQwAFwKOEoAMtz+QSHR3ACsAMxwAL4AlALCYhDaStgQgQaSqNIwSgAmwMiBIhBYwLSo2UKiqPlUhcWlUjJKVCDAMABK-TDZQA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> result </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">transpileFiles</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">"file1.ts"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"file2.ts"</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> luaTarget</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">LuaTarget</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Lua53</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">diagnostics</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">emitResult</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="transpileproject"></a>TranspileProject<a class="hash-link" href="#transpileproject" title="Direct link to heading">#</a></h3><p>Transpile a TypeScript project to Lua.</p><p><strong>Arguments:</strong></p><ul><li>tsConfigPath: string - The file path to a TypeScript project's <code>tsconfig.json</code> file.</li><li><em>[Optional]</em> extendedOptions: tstl.CompilerOptions - The tsConfig already contains options, this extends those options.</li></ul><p><strong>Example:</strong></p><div class="mdxCodeBlock_1zKU"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a aria-label="Open code on playground" class="playgroundButton_3DKR" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xqmAbOAzKCEOAIhgE8wBTVAYymDBgFoYJnsBXZEgbgCh+tCADsscKDU7Z4AXgxZsAOhhRkYsMGxUACoQBWVWjAAUZOqLzAA5kv2pRJADRwA3nC7IAKsijWqMABcCjhKADLcPn4B4dwArADMcAC+AJQCwmIQ2krYENYmkqjSMEoAJsDI1iIQWMC0qOlCog45eQVFJUpUIMAwAEpSMulAA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> result </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">transpileProject</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">"tsconfig.json"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> luaTarget</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">LuaTarget</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Lua53</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">diagnostics</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">emitResult</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="transpilevirtualproject"></a>TranspileVirtualProject<a class="hash-link" href="#transpilevirtualproject" title="Direct link to heading">#</a></h3><p>Transpile a virtual project to Lua. A virtual project is a record (like an object literal for example) where keys are file names, and values are the contents of these files. This can be used to transpile a collection of files without having these files physically on disk.</p><p><strong>Arguments:</strong></p><ul><li>Files: Record<string, string> - A record of fileName keys and fileContent values.</li><li><em>[Optional]</em> Options: tstl.CompilerOptions - CompilerOptions to use.</li></ul><p><strong>Example:</strong></p><div class="mdxCodeBlock_1zKU"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a aria-label="Open code on playground" class="playgroundButton_3DKR" target="_blank" href="/play/#code/JYWwDg9gTgLgBAKjgQwM5xqmAbOAzKCEOAIhgE8wBTVAYymDBgFoYJnsBXZEgbgCh+tCADsscKDU7Z4AXgxZsAOhhRkYsMGxUAasFjdsABUIArKrRgAKfnDgBvW3dJ4tVAIwrUJAFxwABsJi8HgQEHDyJABGyFB8-gA0TnYkrtoATF6+AUHiMVARpDEAXvFJdgC+5Q5wXMgAKrEA5lQwfpg4SgAy3I1QLTDd3ACsAMxwVfwAlAK5ENpK2BBNVpKo0oMAJsDITSIQWMC0qDNCoqjzVIvLq1IyKmoabpsAYm4nvEA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">as</span><span class="token plain"> tstl </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"typescript-to-lua"</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> result </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">transpileVirtualProject</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"file1.ts"</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token template-string string" style="color:#e3116c">const foo = "bar";</span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"file2.ts"</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token template-string string" style="color:#e3116c">const bar = "baz";</span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> luaTarget</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">LuaTarget</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access maybe-class-name">Lua53</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">diagnostics</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token console class-name">console</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">log</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">result</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">transpiledFiles</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="low-level-api"></a>Low-level API<a class="hash-link" href="#low-level-api" title="Direct link to heading">#</a></h2><p>On the contrast with high-level API, low-level API requires you to to manage TypeScript project yourself. See <a href="https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API" target="_blank" rel="noopener noreferrer">Using the Compiler API</a> page for the introduction to TypeScript API.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="transpile"></a>Transpile<a class="hash-link" href="#transpile" title="Direct link to heading">#</a></h3><p><strong>Arguments:</strong></p><ul><li>program: ts.Program - The TypeScript program to transpile (note: unlike the high-level API, compilerOptions is part of the program and cannot be supplied separately).</li><li><em>[Optional]</em> sourceFiles: ts.SourceFile[] - A collection of <code>SourceFile</code>s to transpile, <code>program.getSourceFiles()</code> by default.</li><li><em>[Optional]</em> customTransformers: ts.CustomTransformers - List of extra <a href="/docs/configuration#transformers">TypeScript transformers</a>.</li><li><em>[Optional]</em> plugins: tstl.Plugin[] - List of <a href="/docs/api/plugins">TypeScriptToLua plugins</a>.</li><li><em>[Optional]</em> emitHost: tstl.EmitHost - Provides the methods for reading/writing files, useful in cases where you need something other than regular reading from disk. Defaults to <code>ts.sys</code>.</li></ul><p><strong>Example:</strong></p><div class="mdxCodeBlock_1zKU"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a aria-label="Open code on playground" class="playgroundButton_3DKR" target="_blank" href="/play/#code/MYewdgzgLgBATgUwA4jlAIgSwIYHMwjSbAwC8MU0ANgHTCLZQJZ4FHABKyqTcAFFDgBXBAEoA3AChQkWDIBmmXADFMVBADlsAWwRkYSRgAsaiCCCoA3BHwD6tgCaY4YHQgA0MAESUFSmgBW5mBeEtLg0AbYcBAIDgDCINra2GAOADKYYHrklFC0hjEIiWCKKmoIAOqYUEYAygCe0AjafH7l6lq6YZjyMHyFsQlJKWmZ2TQIcHCoEDTqYLi1MAB8MAAMojAA3pIwUUXDyakZWQiT07M08qgAotjARnyIKGgs+IRQxGH7iFBCLikAF9JOFZAYZrg4Dp9JQ6AwmAAFSHQ1qDOKJY5jM7XCpdBAQTzoo6jU4TEBIL4RMIySLbCjQyBICoOVTqQkwJysT7ECAALgZqQgzPU7zYX2AEBgQNh1BogiFIps9KQKJhQLCYMiLRqXAgQiosFycp1UAAKozhSy2QS+BSqZBPAqmdaKhAwqa9QaoNc7g8nnx6a5dE6EAAPWAashrOEQJo0ADucBqCBtfGDHgo4agok1tNgXI+7Clxpo5jQAEE0ug4kIkFRiIxmDgixKIHwANo0btw3AIKDIhC3bQ1MU8yUDNXaUSebvyy1KsfFgC6YUL4t5vrg90ez24bxbG+AEiAA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> reportDiagnostic </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">createDiagnosticReporter</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> configFileName </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> path</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">resolve</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">__dirname</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"tsconfig.json"</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> parsedCommandLine </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">parseConfigFileWithSystem</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">configFileName</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">parsedCommandLine</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">errors</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">length</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">></span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> parsedCommandLine</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">errors</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">forEach</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reportDiagnostic</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">return</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> program </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> ts</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">createProgram</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">parsedCommandLine</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">fileNames</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> parsedCommandLine</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">options</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> transpiledFiles</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> diagnostics</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> transpileDiagnostics </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">transpile</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> program </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> emitResult </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> tstl</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">emitTranspiledFiles</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">options</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> transpiledFiles</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain">emitResult</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">forEach</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token parameter punctuation" style="color:#393A34">{</span><span class="token parameter"> name</span><span class="token parameter punctuation" style="color:#393A34">,</span><span class="token parameter"> text </span><span class="token parameter punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:#393A34">=></span><span class="token plain"> ts</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">sys</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">writeFile</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">name</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> text</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block">
</span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> diagnostics </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> ts</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">sortAndDeduplicateDiagnostics</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token spread operator" style="color:#393A34">...</span><span class="token plain">ts</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">getPreEmitDiagnostics</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">program</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token spread operator" style="color:#393A34">...</span><span class="token plain">transpileDiagnostics</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain">diagnostics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">forEach</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reportDiagnostic</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span></div></code></pre></div></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua.github.io/edit/source/docs/api/overview.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2LL7"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Blog list page navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/advanced/language-extensions"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Language extensions</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/api/plugins"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Plugins »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_2xL- thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#high-level-api" class="table-of-contents__link">High-level API</a><ul><li><a href="#transpilestring" class="table-of-contents__link">TranspileString</a></li><li><a href="#transpilefiles" class="table-of-contents__link">TranspileFiles</a></li><li><a href="#transpileproject" class="table-of-contents__link">TranspileProject</a></li><li><a href="#transpilevirtualproject" class="table-of-contents__link">TranspileVirtualProject</a></li></ul></li><li><a href="#low-level-api" class="table-of-contents__link">Low-level API</a><ul><li><a href="#transpile" class="table-of-contents__link">Transpile</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/configuration">Configuration</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/advanced/writing-declarations">Advanced</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://github.com/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github</a></li><li class="footer__item"><a class="footer__link-item" href="/play">Playground</a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://github.com/TypescriptToLua" target="_blank" rel="noopener noreferrer" class="footerLogoLink_31Aa"><img class="footer__logo" alt="TypescriptToLua Logo" src="/images/logo.png"></a></div><div class="footer__copyright">Copyright © 2021 TypescriptToLua Contributors</div></div></div></footer></div>
<script src="/styles.9e960a30.js"></script>
<script src="/runtime~main.a6dad94e.js"></script>
<script src="/main.3eca3247.js"></script>
<script src="/1.f61e14a0.js"></script>
<script src="/3.25dbb900.js"></script>
<script src="/1be78505.fd95f0c2.js"></script>
<script src="/29.3d07cf4e.js"></script>
<script src="/935f2afb.7b3a4519.js"></script>
<script src="/25.3e7184fc.js"></script>
<script src="/65df3d35.f779a28a.js"></script>
</body>
</html>