91 lines
No EOL
15 KiB
HTML
91 lines
No EOL
15 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Documentation</title><meta name="description" content="Documentation for Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base=".">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
<div class="field">
|
|
<div id="tsd-toolbar-links"></div></div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Documentation</a></div>
|
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-content">
|
|
<div class="tsd-page-title">
|
|
<h2>Documentation</h2></div>
|
|
<div class="tsd-panel tsd-typography"><a id="md:exp-tygoja-" class="tsd-anchor"></a><h1><a href="#md:exp-tygoja-">(EXP) tygoja
|
|
<a href="https://pkg.go.dev/github.com/pocketbase/tygoja"><img src="https://godoc.org/github.com/pocketbase/tygoja?status.svg" alt="GoDoc"></a></a></h1><p><strong>tygoja</strong> is a small helper library for generating TypeScript declarations from Go code.</p>
|
|
<p>The generated typings are intended to be used as import helpers to provide <a href="https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html">ambient TypeScript declarations</a> (aka. <code>.d.ts</code>) for <a href="https://github.com/dop251/goja">goja</a> bindings.</p>
|
|
<blockquote>
|
|
<p><strong>⚠️ Don't use it directly in production! It is not tagged and may change without notice.</strong></p>
|
|
<p><strong>It was created to semi-automate the documentation of the goja integration for PocketBase.</strong></p>
|
|
<p><strong>Use it only as a reference or as a non-critical step in your dev pipeline.</strong></p>
|
|
</blockquote>
|
|
<p><strong>tygoja</strong> is a heavily modified fork of <a href="https://github.com/gzuidhof/tygo">tygo</a> and extends its scope with:</p>
|
|
<ul>
|
|
<li>custom field and method names formatters</li>
|
|
<li>types for interfaces (exported and unexported)</li>
|
|
<li>types for exported interface methods</li>
|
|
<li>types for exported struct methods</li>
|
|
<li>types for exported package level functions (<em>must enable <code>PackageConfig.WithPackageFunctions</code></em>)</li>
|
|
<li>inheritance declarations for embeded structs (<em>embedded pointers are treated as values</em>)</li>
|
|
<li>autoloading all unmapped argument and return types (<em>when possible</em>)</li>
|
|
<li>applying the same <a href="https://pkg.go.dev/github.com/dop251/goja#hdr-Nil">goja's rules</a> when resolving the return types of exported function and methods</li>
|
|
<li>combining multiple packages typings in a single output</li>
|
|
<li>generating all declarations in namespaces with the packages name (both unmapped and mapped)</li>
|
|
<li>preserving comment block new lines</li>
|
|
<li>converting Go comment code blocks to Markdown code blocks</li>
|
|
<li>and others...</li>
|
|
</ul>
|
|
<p>Note that by default the generated typings are not generated with <code>export</code> since the intended usage is to map them to your custom goja bindings.
|
|
This mapping could be defined in the <code>Config.Heading</code> field usually with the <code>declare</code> keyword (eg. <code>declare let someGojaProp: app.Cache</code>).</p>
|
|
<a id="md:example" class="tsd-anchor"></a><h2><a href="#md:example">Example</a></h2><pre><code class="language-go"><span class="hl-0">package</span><span class="hl-1"> main</span><br/><br/><span class="hl-0">import</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-2">"log"</span><br/><span class="hl-1"> </span><span class="hl-2">"os"</span><br/><br/><span class="hl-1"> </span><span class="hl-2">"github.com/pocketbase/tygoja"</span><br/><span class="hl-1">)</span><br/><br/><span class="hl-0">func</span><span class="hl-1"> </span><span class="hl-3">main</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">gen</span><span class="hl-1"> := tygoja.</span><span class="hl-3">New</span><span class="hl-1">(tygoja.Config{</span><br/><span class="hl-1"> Packages: </span><span class="hl-0">map</span><span class="hl-1">[</span><span class="hl-5">string</span><span class="hl-1">][]</span><span class="hl-5">string</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-2">"github.com/pocketbase/tygoja/test/a"</span><span class="hl-1">: {</span><span class="hl-2">"*"</span><span class="hl-1">},</span><br/><span class="hl-1"> </span><span class="hl-2">"github.com/pocketbase/tygoja/test/b"</span><span class="hl-1">: {</span><span class="hl-2">"*"</span><span class="hl-1">},</span><br/><span class="hl-1"> </span><span class="hl-2">"github.com/pocketbase/tygoja/test/c"</span><span class="hl-1">: {</span><span class="hl-2">"Example2"</span><span class="hl-1">, </span><span class="hl-2">"Handler"</span><span class="hl-1">},</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> Heading: </span><span class="hl-2">`declare var $app: c.Handler; // bind other fields `</span><span class="hl-1">,</span><br/><span class="hl-1"> WithPackageFunctions: </span><span class="hl-0">true</span><span class="hl-1">,</span><br/><span class="hl-1"> })</span><br/><br/><span class="hl-1"> </span><span class="hl-4">result</span><span class="hl-1">, </span><span class="hl-4">err</span><span class="hl-1"> := gen.</span><span class="hl-3">Generate</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1"> err != </span><span class="hl-0">nil</span><span class="hl-1"> {</span><br/><span class="hl-1"> log.</span><span class="hl-3">Fatal</span><span class="hl-1">(err)</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1"> </span><span class="hl-4">err</span><span class="hl-1"> := os.</span><span class="hl-3">WriteFile</span><span class="hl-1">(</span><span class="hl-2">"./types.d.ts"</span><span class="hl-1">, []</span><span class="hl-3">byte</span><span class="hl-1">(result), </span><span class="hl-7">0644</span><span class="hl-1">); err != </span><span class="hl-0">nil</span><span class="hl-1"> {</span><br/><span class="hl-1"> log.</span><span class="hl-3">Fatal</span><span class="hl-1">(err)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can also combine it with <a href="https://typedoc.org/">typedoc</a> to create HTML/JSON docs from the generated declaration(s).</p>
|
|
<p>See the package <code>/test</code> directory for example output.</p>
|
|
<p>For a more detailed example you can also explore the <a href="https://github.com/pocketbase/pocketbase/tree/develop/plugins/jsvm/internal/docs">PocketBase's jsvm plugin</a>.</p>
|
|
<a id="md:known-issues-and-limitations" class="tsd-anchor"></a><h2><a href="#md:known-issues-and-limitations">Known issues and limitations</a></h2><ul>
|
|
<li>Multiple versions of the same package may have unexpected declaration since all versions will be under the same namespace.</li>
|
|
<li>For easier generation, it relies on TypeScript declarations merging, meaning that the generated types may not be very compact.</li>
|
|
<li>Package level functions and constants, that are reserved JS identifier, are prefixed with underscore (eg. <code>_in()</code>).</li>
|
|
</ul>
|
|
</div></div>
|
|
<div class="col-sidebar">
|
|
<div class="page-menu">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<ul id="tsd-filter-options">
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li>
|
|
<ul>
|
|
<li><a href="#md:exp-tygoja-"><span>(EXP) tygoja
|
|
</span></a></li>
|
|
<li>
|
|
<ul>
|
|
<li><a href="#md:example"><span>Example</span></a></li>
|
|
<li><a href="#md:known-issues-and-limitations"><span>Known issues and limitations</span></a></li></ul></li></ul></li></ul></div></details></div>
|
|
<div class="site-menu">
|
|
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Documentation</span></a>
|
|
<ul class="tsd-small-nested-navigation">
|
|
<li><a href="modules/a.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>a</span></a></li>
|
|
<li><a href="modules/b.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>b</span></a></li>
|
|
<li><a href="modules/c.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>c</span></a></li>
|
|
<li><a href="modules/time.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>time</span></a></li>
|
|
<li><a href="types/_TygojaAny.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>_<wbr/>Tygoja<wbr/>Any</span></a></li>
|
|
<li><a href="types/_TygojaDict.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>_<wbr/>Tygoja<wbr/>Dict</span></a></li>
|
|
<li><a href="functions/_app.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>$app</span></a></li></ul></nav></div></div></div>
|
|
<div class="tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
<div class="overlay"></div></body></html> |