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
20 lines (20 loc) · 28.7 KB
/
index.html
File metadata and controls
20 lines (20 loc) · 28.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!doctype html>
<html lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.ff31de0ff">
<link rel="alternate" type="application/rss+xml" href="/TypeScriptToLua.github.io/blog/rss.xml" title="TypeScriptToLua Blog RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/TypeScriptToLua.github.io/blog/atom.xml" title="TypeScriptToLua Blog Atom Feed">
<link rel="search" type="application/opensearchdescription+xml" title="TypeScriptToLua" href="/TypeScriptToLua.github.io/opensearch.xml"><title data-react-helmet="true">Getting Started | TypeScriptToLua</title><meta data-react-helmet="true" property="og:url" content="https://typescripttolua.github.io/TypeScriptToLua.github.io/docs/getting-started"><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="Getting Started | TypeScriptToLua"><meta data-react-helmet="true" name="description" content="This is a quick introduction into project setup and our CLI. For a TypeScript quick start please read//www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html"><meta data-react-helmet="true" property="og:description" content="This is a quick introduction into project setup and our CLI. For a TypeScript quick start please read//www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html"><link data-react-helmet="true" rel="shortcut icon" href="/TypeScriptToLua.github.io/images/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://typescripttolua.github.io/TypeScriptToLua.github.io/docs/getting-started"><link data-react-helmet="true" rel="alternate" href="https://typescripttolua.github.io/TypeScriptToLua.github.io/docs/getting-started" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://typescripttolua.github.io/TypeScriptToLua.github.io/docs/getting-started" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/TypeScriptToLua.github.io/assets/css/styles.18adf632.css">
<link rel="preload" href="/TypeScriptToLua.github.io/assets/js/runtime~main.a63cd74a.js" as="script">
<link rel="preload" href="/TypeScriptToLua.github.io/assets/js/main.311b8aa1.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">
<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top navbarHideable_2qcr"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle" type="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></button><a class="navbar__brand" href="/TypeScriptToLua.github.io/"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><strong class="navbar__title">TypeScriptToLua</strong></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/TypeScriptToLua.github.io/docs/getting-started">Docs</a><a class="navbar__item navbar__link" href="/TypeScriptToLua.github.io/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 header-discord-link" aria-label="Discord Server"></a><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="react-toggle displayOnlyInLargeViewport_GrZ2 react-toggle--disabled" role="button" tabindex="-1"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span 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></span></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="/TypeScriptToLua.github.io/"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--dark_hz6m 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 aria-current="page" class="menu__link navbar__link--active" href="/TypeScriptToLua.github.io/docs/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/play">Playground</a></li><li class="menu__list-item"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="menu__link header-discord-link" aria-label="Discord Server"></a></li><li class="menu__list-item"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="menu__link header-github-link" aria-label="GitHub repository"></a></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><div class="docSidebarContainer_3Kbt" role="complementary"><div class="sidebar_15mo sidebarWithHideableNavbar_267A"><a tabindex="-1" class="sidebarLogo_3h0W" href="/TypeScriptToLua.github.io/"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--light_3UqQ"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua" class="themedImage_1VuW themedImage--dark_hz6m"><strong>TypeScriptToLua</strong></a><div class="menu menu--responsive thin-scrollbar menu_Bmed"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_fgN0" 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 aria-current="page" class="menu__link menu__link--active active" href="/TypeScriptToLua.github.io/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/configuration">Configuration</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/caveats">Caveats</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/the-self-parameter">The Self Parameter</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/external-lua-code">External Lua Code</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/publishing-modules">Publishing Modules</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/editor-support">Editor Support</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/advanced/writing-declarations">Writing Declarations</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/advanced/compiler-annotations">Compiler Annotations</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/advanced/language-extensions">Language extensions</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/advanced/automated-testing">Unit Testing</a></li><li class="menu__list-item"><a class="menu__link" href="/TypeScriptToLua.github.io/docs/jsx">JSX</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">API</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/TypeScriptToLua.github.io/docs/api/overview">Overview</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/TypeScriptToLua.github.io/docs/api/plugins">Plugins</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/TypeScriptToLua.github.io/docs/api/printer">Printer</a></li></ul></li></ul></div></div></div><main class="docMainContainer_3ufF"><div class="container padding-vert--lg docItemWrapper_3FMP"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><header><h1 class="docTitle_3a4h">Getting Started</h1></header><div class="markdown"><p>This is a quick introduction into project setup and our CLI. For a TypeScript quick start please read: <a href="https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html" target="_blank" rel="noopener noreferrer">https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html</a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="installation"></a>Installation<a class="hash-link" href="#installation" title="Direct link to heading">#</a></h2><p>TypeScriptToLua is built using <a href="https://nodejs.org/" target="_blank" rel="noopener noreferrer">Node.js</a> and distributed via <a href="https://www.npmjs.com/" target="_blank" rel="noopener noreferrer">npm</a>. To install it, you need to create a <code>package.json</code> file in the root of your project, containing at least <code>{}</code>. Then you can use this command to add the latest version of TypeScriptToLua to your project:</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><div tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar"><div class="codeBlockLines_39YC" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> -D typescript-to-lua</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o">Copy</button></div></div><div class="admonition admonition-note alert alert--secondary"><div class="admonition-heading"><h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width="14" height="16" viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</h5></div><div class="admonition-content"><p>Installing <code>tstl</code> locally is recommended to keep your build reproducible and prevent version conflicts between projects. However, it is also possible to install it globally with <code>npm install --global typescript-to-lua</code> or run it without install using <code>npx typescript-to-lua</code>.</p></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="project-setup"></a>Project setup<a class="hash-link" href="#project-setup" title="Direct link to heading">#</a></h2><p>TypeScriptToLua shares the configuration format with vanilla TypeScript. This file is called <code>tsconfig.json</code> and should be located in your project's root.</p><p>Basic recommended configuration:</p><div class="codeBlockContainer_K1bP"><div style="color:#393A34;background-color:#f6f8fa" class="codeBlockTitle_eoMF">tsconfig.json</div><div class="codeBlockContent_hGly json"><div tabindex="0" class="prism-code language-json codeBlock_23N8 thin-scrollbar codeBlockWithTitle_2JqI"><div class="codeBlockLines_39YC" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><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 property" style="color:#36acaa">"compilerOptions"</span><span class="token operator" 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"> </span><span class="token property" style="color:#36acaa">"target"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"esnext"</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 property" style="color:#36acaa">"lib"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">"esnext"</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 property" style="color:#36acaa">"moduleResolution"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"node"</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 property" style="color:#36acaa">"types"</span><span class="token operator" style="color:#393A34">:</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 property" style="color:#36acaa">"strict"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</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 property" style="color:#36acaa">"tstl"</span><span class="token operator" 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"> </span><span class="token property" style="color:#36acaa">"luaTarget"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"JIT"</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 punctuation" style="color:#393A34">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o">Copy</button></div></div><p>Check out <a href="/TypeScriptToLua.github.io/docs/configuration">Configuration</a> page for more information.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="building-your-project"></a>Building your project<a class="hash-link" href="#building-your-project" title="Direct link to heading">#</a></h2><p>Our command line interface is called <code>tstl</code> and it works almost exactly as TypeScript's <code>tsc</code>.</p><p>Since <code>tstl</code> is installed locally to your project, you cannot run it as a bare command in your terminal, so it's recommended to use it with <a href="https://docs.npmjs.com/misc/scripts" target="_blank" rel="noopener noreferrer">npm scripts</a>.</p><div class="codeBlockContainer_K1bP"><div style="color:#393A34;background-color:#f6f8fa" class="codeBlockTitle_eoMF">package.json</div><div class="codeBlockContent_hGly json"><div tabindex="0" class="prism-code language-json codeBlock_23N8 thin-scrollbar codeBlockWithTitle_2JqI"><div class="codeBlockLines_39YC" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><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 property" style="color:#36acaa">"private"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</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 property" style="color:#36acaa">"scripts"</span><span class="token operator" 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"> </span><span class="token property" style="color:#36acaa">"build"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"tstl"</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 property" style="color:#36acaa">"dev"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"tstl --watch"</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 property" style="color:#36acaa">"devDependencies"</span><span class="token operator" 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"> </span><span class="token property" style="color:#36acaa">"typescript-to-lua"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"..."</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 punctuation" style="color:#393A34">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o">Copy</button></div></div><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><div tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar"><div class="codeBlockLines_39YC" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic"># Build</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> run build</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 comment" style="color:#999988;font-style:italic"># Build and watch for changes</span><span class="token plain"></span></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> run dev</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o">Copy</button></div></div><div class="admonition admonition-note alert alert--secondary"><div class="admonition-heading"><h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width="14" height="16" viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</h5></div><div class="admonition-content"><p>For testing purposes you also can run <code>tstl</code> directly from your terminal with <code>node_modules/.bin/tstl</code> or <code>npx tstl</code>.</p></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="declarations"></a>Declarations<a class="hash-link" href="#declarations" title="Direct link to heading">#</a></h2><p>The real power of this transpiler is usage together with good declarations for the Lua API provided. Some examples of Lua interface declarations can be found here:</p><ul><li><a href="https://github.com/TypeScriptToLua/lua-types" target="_blank" rel="noopener noreferrer">Lua Standard Library</a></li><li><a href="https://github.com/ModDota/API/tree/master/declarations/server" target="_blank" rel="noopener noreferrer">Dota 2 Custom Games</a> (<a href="https://github.com/ModDota/TypeScriptAddonTemplate" target="_blank" rel="noopener noreferrer">template</a>)</li><li><a href="https://github.com/ts-defold/types" target="_blank" rel="noopener noreferrer">Defold Game Engine Scripting</a></li><li><a href="https://github.com/hazzard993/love-typescript-definitions" target="_blank" rel="noopener noreferrer">LÖVE 2D Game Development</a></li><li><a href="https://github.com/wartoshika/wow-declarations" target="_blank" rel="noopener noreferrer">World of Warcraft - Addon Development</a></li><li><a href="https://github.com/wartoshika/wow-classic-declarations" target="_blank" rel="noopener noreferrer">World of Warcraft Classic - Addon Development</a></li><li><a href="https://github.com/GlassBricks/typed-factorio" target="_blank" rel="noopener noreferrer">Typed Factorio</a></li><li><a href="https://isaacscript.github.io" target="_blank" rel="noopener noreferrer">The Binding of Isaac: Rebirth</a></li></ul></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/getting-started.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_2_ui" aria-label="Edit page"><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="Docs pages navigation"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/TypeScriptToLua.github.io/docs/configuration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuration »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installation" class="table-of-contents__link">Installation</a></li><li><a href="#project-setup" class="table-of-contents__link">Project setup</a></li><li><a href="#building-your-project" class="table-of-contents__link">Building your project</a></li><li><a href="#declarations" class="table-of-contents__link">Declarations</a></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"><div class="footer__title">Docs</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/TypeScriptToLua.github.io/docs/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/TypeScriptToLua.github.io/docs/configuration">Configuration</a></li><li class="footer__item"><a class="footer__link-item" href="/TypeScriptToLua.github.io/docs/advanced/writing-declarations">Advanced</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><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"><div class="footer__title">More</div><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="/TypeScriptToLua.github.io/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_MyFc"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua Logo" class="themedImage_1VuW themedImage--light_3UqQ footer__logo"><img src="/TypeScriptToLua.github.io/images/logo.png" alt="TypeScriptToLua Logo" class="themedImage_1VuW themedImage--dark_hz6m footer__logo"></a></div><div class="footer__copyright">Copyright © 2021 TypeScriptToLua Contributors</div></div></div></footer></div>
<script src="/TypeScriptToLua.github.io/assets/js/runtime~main.a63cd74a.js"></script>
<script src="/TypeScriptToLua.github.io/assets/js/main.311b8aa1.js"></script>
</body>
</html>