Skip to content

Commit a3b21e4

Browse files
CMCDragonkaiCMCDragonkai
committed
Updated docs
1 parent 40fdd0e commit a3b21e4

14 files changed

+214
-16
lines changed

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/lib_Library.default.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,9 @@ <h3>some<wbr>Param</h3>
153153
<li class=" tsd-kind-module">
154154
<a href="../modules/lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
155155
</li>
156+
<li class=" tsd-kind-module">
157+
<a href="../modules/lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
158+
</li>
156159
<li class=" tsd-kind-module">
157160
<a href="../modules/lib_test_level.html">lib/test-<wbr>level</a>
158161
</li>

‎docs/classes/lib_NumPair.default.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,9 @@ <h3>num2</h3>
167167
<li class="current tsd-kind-module">
168168
<a href="../modules/lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
169169
</li>
170+
<li class=" tsd-kind-module">
171+
<a href="../modules/lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
172+
</li>
170173
<li class=" tsd-kind-module">
171174
<a href="../modules/lib_test_level.html">lib/test-<wbr>level</a>
172175
</li>

‎docs/index.html‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,9 @@ <h2>Installation</h2>
7777
<pre><code class="language-sh"><span style="color: #000000">nix-env -f ./release.nix --install --attr application</span>
7878
</code></pre>
7979
<p>Install into Docker:</p>
80-
<pre><code class="language-sh"><span style="color: #000000">docker load --input </span><span style="color: #A31515">&quot;$(nix-build ./release.nix --attr docker)&quot;</span>
80+
<pre><code class="language-sh"><span style="color: #000000">loaded=</span><span style="color: #A31515">&quot;$(docker load --input &quot;$(nix-build ./release.nix --attr docker)&quot;)&quot;</span>
81+
<span style="color: #000000">image=</span><span style="color: #A31515">&quot;$(cut -d&#039; &#039; -f3 </span><span style="color: #000000">&lt;&lt;&lt;</span><span style="color: #A31515"> &quot;$loaded&quot;)&quot;</span>
82+
<span style="color: #000000">docker run -it </span><span style="color: #A31515">&quot;</span><span style="color: #001080">$image</span><span style="color: #A31515">&quot;</span>
8183
</code></pre>
8284
<a href="#development" id="development" style="color: inherit; text-decoration: none;">
8385
<h2>Development</h2>
@@ -120,19 +122,6 @@ <h3>Path Aliases</h3>
120122
</a>
121123
<p>Due to <a href="https://github.com/microsoft/TypeScript/issues/10866">https://github.com/microsoft/TypeScript/issues/10866</a>, you cannot use path aliases without a bundler like Webpack to further transform the generated JavaScript code in order to resolve the path aliases. Because this is a simple library demonstration, there&#39;s no need to use a bundler. In fact, for such libraries, it is far more efficient to not bundle the code.</p>
122124
<p>However, we have left the path alias configuration in <code>tsconfig.json</code>, <code>jest.config.js</code> and in the tests we are making use of the <code>@</code> alias.</p>
123-
<a href="#vscode-path-aliases" id="vscode-path-aliases" style="color: inherit; text-decoration: none;">
124-
<h4>VSCode Path Aliases</h4>
125-
</a>
126-
<p>VSCode cannot follow path aliases in our tests due to
127-
<a href="https://github.com/microsoft/vscode/issues/94474">https://github.com/microsoft/vscode/issues/94474</a>.</p>
128-
<p>To resolve this, add <code>./tests/**/*</code> into the <code>tsconfig</code> <code>include</code> section:</p>
129-
<pre><code class="language-json"><span style="color: #000000"> </span><span style="color: #A31515">&quot;include&quot;</span><span style="color: #000000">: [</span>
130-
<span style="color: #000000"> </span><span style="color: #A31515">&quot;./src/**/*&quot;</span><span style="color: #000000">,</span>
131-
<span style="color: #000000"> </span><span style="color: #A31515">&quot;./tests/**/*&#039;</span>
132-
<span style="color: #A31515"> ]</span>
133-
</code></pre>
134-
<p>This will however make <code>tsc</code> build the <code>tests</code> into the <code>dist</code> output.</p>
135-
<p><strong>Therefore this fix should only be done in your own workspace, do not commit or push this change up.</strong></p>
136125
<a href="#native-module-toolchain" id="native-module-toolchain" style="color: inherit; text-decoration: none;">
137126
<h3>Native Module Toolchain</h3>
138127
</a>
@@ -227,6 +216,9 @@ <h3>Publishing</h3>
227216
<li class=" tsd-kind-module">
228217
<a href="modules/lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
229218
</li>
219+
<li class=" tsd-kind-module">
220+
<a href="modules/lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
221+
</li>
230222
<li class=" tsd-kind-module">
231223
<a href="modules/lib_test_level.html">lib/test-<wbr>level</a>
232224
</li>

‎docs/modules.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ <h3>Modules</h3>
6868
<li class="tsd-kind-module"><a href="modules/index.html" class="tsd-kind-icon">index</a></li>
6969
<li class="tsd-kind-module"><a href="modules/lib_Library.html" class="tsd-kind-icon">lib/<wbr>Library</a></li>
7070
<li class="tsd-kind-module"><a href="modules/lib_NumPair.html" class="tsd-kind-icon">lib/<wbr>Num<wbr>Pair</a></li>
71+
<li class="tsd-kind-module"><a href="modules/lib_test_fd_lock.html" class="tsd-kind-icon">lib/test-<wbr>fd-<wbr>lock</a></li>
7172
<li class="tsd-kind-module"><a href="modules/lib_test_level.html" class="tsd-kind-icon">lib/test-<wbr>level</a></li>
7273
<li class="tsd-kind-module"><a href="modules/lib_test_utp_native.html" class="tsd-kind-icon">lib/test-<wbr>utp-<wbr>native</a></li>
7374
<li class="tsd-kind-module"><a href="modules/lib_workers_test_workers.html" class="tsd-kind-icon">lib/workers/test-<wbr>workers</a></li>
@@ -96,6 +97,9 @@ <h3>Modules</h3>
9697
<li class=" tsd-kind-module">
9798
<a href="modules/lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
9899
</li>
100+
<li class=" tsd-kind-module">
101+
<a href="modules/lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
102+
</li>
99103
<li class=" tsd-kind-module">
100104
<a href="modules/lib_test_level.html">lib/test-<wbr>level</a>
101105
</li>

‎docs/modules/bin_typescript_demo_lib.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h3>default</h3>
9090
<li class="tsd-description">
9191
<aside class="tsd-sources">
9292
<ul>
93-
<li>Defined in <a href="https://github.com/MatrixAI/TypeScript-Demo-Lib/blob/master/src/bin/typescript-demo-lib.ts#L13">bin/typescript-demo-lib.ts:13</a></li>
93+
<li>Defined in <a href="https://github.com/MatrixAI/TypeScript-Demo-Lib/blob/master/src/bin/typescript-demo-lib.ts#L14">bin/typescript-demo-lib.ts:14</a></li>
9494
</ul>
9595
</aside>
9696
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -123,6 +123,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
123123
<li class=" tsd-kind-module">
124124
<a href="lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
125125
</li>
126+
<li class=" tsd-kind-module">
127+
<a href="lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
128+
</li>
126129
<li class=" tsd-kind-module">
127130
<a href="lib_test_level.html">lib/test-<wbr>level</a>
128131
</li>

‎docs/modules/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@ <h3>Library</h3>
105105
<li class=" tsd-kind-module">
106106
<a href="lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
107107
</li>
108+
<li class=" tsd-kind-module">
109+
<a href="lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
110+
</li>
108111
<li class=" tsd-kind-module">
109112
<a href="lib_test_level.html">lib/test-<wbr>level</a>
110113
</li>

‎docs/modules/lib_Library.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ <h3>Classes</h3>
9797
<li class=" tsd-kind-module">
9898
<a href="lib_NumPair.html">lib/<wbr>Num<wbr>Pair</a>
9999
</li>
100+
<li class=" tsd-kind-module">
101+
<a href="lib_test_fd_lock.html">lib/test-<wbr>fd-<wbr>lock</a>
102+
</li>
100103
<li class=" tsd-kind-module">
101104
<a href="lib_test_level.html">lib/test-<wbr>level</a>
102105
</li>

0 commit comments

Comments
 (0)