Skip to content

Commit c3dad12

Browse files
formanforman
committed
updated API docs
1 parent 2236f0c commit c3dad12

File tree

162 files changed

+565
-538
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+565
-538
lines changed

‎README.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,11 @@ export default function CommandButton({ command }: CommandButtonProps) {
301301
}
302302
```
303303

304+
# Documentation
305+
306+
We currently only have this file and the
307+
[API docs](https://forman.github.io/extendit/), sorry.
308+
304309
# Acknowledgements
305310

306311
ExtendIt.js currently uses the awesome libraries
@@ -309,6 +314,13 @@ ExtendIt.js currently uses the awesome libraries
309314
* [memoize-one](https://github.com/alexreardon/memoize-one) for implementing state selector functions
310315
* [zustand](https://github.com/pmndrs/zustand) for state management
311316

317+
# License
318+
319+
Copyright © 2023 Norman Fomferra
320+
321+
Permissions are hereby granted under the terms of the MIT License:
322+
https://opensource.org/licenses/MIT.
323+
312324
# Development
313325

314326
## Source Code
@@ -325,12 +337,12 @@ $ npm install
325337

326338
Now the following scripts are available that can be started with `npm run`:
327339

328-
* `dev` - run the UI demo in development mode
340+
* `dev` - run the **React Demo** in development mode
329341
* `build` - build the library, outputs to `./dist`
330342
* `lint` - run `eslint` on project sources
331343
* `test` - run project unit tests
332344
* `coverage` - generate project coverage report in `./coverage`
333-
* `typedoc` - generate project API docs in `./docs/api`
345+
* `typedoc` - generate project API docs in `./docs`
334346

335347
## Configuration
336348

@@ -365,10 +377,3 @@ stick to the following order:
365377
If we also have resource dependencies (`*.css`, `*.json`, `*.svg`, ...),
366378
we first import TypeScript source dependencies, then separated by a
367379
newline, insert resource dependencies in the same order as source dependencies.
368-
369-
# License
370-
371-
Copyright © 2023 Norman Fomferra
372-
373-
Permissions are hereby granted under the terms of the MIT License:
374-
https://opensource.org/licenses/MIT.

‎docs/classes/util.AssertionError.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ <h4>Hierarchy</h4>
2727
<ul class="tsd-hierarchy">
2828
<li><span class="target">AssertionError</span></li></ul></li></ul></section><aside class="tsd-sources">
2929
<ul>
30-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/assert.ts#L10">src/framework/util/assert.ts:10</a></li></ul></aside>
30+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/assert.ts#L10">src/framework/util/assert.ts:10</a></li></ul></aside>
3131
<section class="tsd-panel-group tsd-index-group">
3232
<section class="tsd-panel tsd-index-panel">
3333
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -156,7 +156,7 @@ <h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-
156156
<h4 class="tsd-returns-title">Returns <a href="util.AssertionError.html" class="tsd-signature-type tsd-kind-class">AssertionError</a></h4>
157157
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
158158
<ul>
159-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/assert.ts#L15">src/framework/util/assert.ts:15</a></li></ul></aside></li></ul></section></section></div>
159+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/assert.ts#L15">src/framework/util/assert.ts:15</a></li></ul></aside></li></ul></section></section></div>
160160
<div class="col-sidebar">
161161
<div class="page-menu">
162162
<div class="tsd-navigation settings">

‎docs/classes/util.Disposable.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h4>Implements</h4>
3535
<ul class="tsd-hierarchy">
3636
<li><a href="../interfaces/util.DisposableLike.html" class="tsd-signature-type tsd-kind-interface">DisposableLike</a></li></ul></section><aside class="tsd-sources">
3737
<ul>
38-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/disposable.ts#L21">src/framework/util/disposable.ts:21</a></li></ul></aside>
38+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/disposable.ts#L21">src/framework/util/disposable.ts:21</a></li></ul></aside>
3939
<section class="tsd-panel-group tsd-index-group">
4040
<section class="tsd-panel tsd-index-panel">
4141
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -81,7 +81,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
8181
<h4 class="tsd-returns-title">Returns <a href="util.Disposable.html" class="tsd-signature-type tsd-kind-class">Disposable</a></h4>
8282
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
8383
<ul>
84-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/disposable.ts#L50">src/framework/util/disposable.ts:50</a></li></ul></aside></li></ul></section></section>
84+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/disposable.ts#L50">src/framework/util/disposable.ts:50</a></li></ul></aside></li></ul></section></section>
8585
<section class="tsd-panel-group tsd-member-group">
8686
<h2>Properties</h2>
8787
<section class="tsd-panel tsd-member tsd-is-private"><a id="_onDispose" class="tsd-anchor"></a>
@@ -96,7 +96,7 @@ <h4>Type declaration</h4>
9696
<li class="tsd-description">
9797
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
9898
<ul>
99-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/disposable.ts#L40">src/framework/util/disposable.ts:40</a></li></ul></aside></section></section>
99+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/disposable.ts#L40">src/framework/util/disposable.ts:40</a></li></ul></aside></section></section>
100100
<section class="tsd-panel-group tsd-member-group">
101101
<h2>Methods</h2>
102102
<section class="tsd-panel tsd-member"><a id="dispose" class="tsd-anchor"></a>
@@ -110,7 +110,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
110110
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
111111
<p>Implementation of <a href="../interfaces/util.DisposableLike.html">DisposableLike</a>.<a href="../interfaces/util.DisposableLike.html#dispose">dispose</a></p>
112112
<ul>
113-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/disposable.ts#L57">src/framework/util/disposable.ts:57</a></li></ul></aside></li></ul></section>
113+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/disposable.ts#L57">src/framework/util/disposable.ts:57</a></li></ul></aside></li></ul></section>
114114
<section class="tsd-panel tsd-member"><a id="from" class="tsd-anchor"></a>
115115
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
116116
<ul class="tsd-signatures">
@@ -135,7 +135,7 @@ <h4 class="tsd-returns-title">Returns <a href="util.Disposable.html" class="tsd-
135135

136136
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
137137
<ul>
138-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/disposable.ts#L32">src/framework/util/disposable.ts:32</a></li></ul></aside></li></ul></section></section></div>
138+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/disposable.ts#L32">src/framework/util/disposable.ts:32</a></li></ul></aside></li></ul></section></section></div>
139139
<div class="col-sidebar">
140140
<div class="page-menu">
141141
<div class="tsd-navigation settings">

‎docs/classes/util.JsonValidationError.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ <h4>Hierarchy</h4>
2727
<ul class="tsd-hierarchy">
2828
<li><span class="target">JsonValidationError</span></li></ul></li></ul></section><aside class="tsd-sources">
2929
<ul>
30-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/json/validate-json.ts#L15">src/framework/util/json/validate-json.ts:15</a></li></ul></aside>
30+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/json/validate-json.ts#L15">src/framework/util/json/validate-json.ts:15</a></li></ul></aside>
3131
<section class="tsd-panel-group tsd-index-group">
3232
<section class="tsd-panel tsd-index-panel">
3333
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -67,14 +67,14 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
6767
<h4 class="tsd-returns-title">Returns <a href="util.JsonValidationError.html" class="tsd-signature-type tsd-kind-class">JsonValidationError</a></h4><aside class="tsd-sources">
6868
<p>Overrides Error.constructor</p>
6969
<ul>
70-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/json/validate-json.ts#L16">src/framework/util/json/validate-json.ts:16</a></li></ul></aside></li></ul></section></section>
70+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/json/validate-json.ts#L16">src/framework/util/json/validate-json.ts:16</a></li></ul></aside></li></ul></section></section>
7171
<section class="tsd-panel-group tsd-member-group">
7272
<h2>Properties</h2>
7373
<section class="tsd-panel tsd-member"><a id="errors" class="tsd-anchor"></a>
7474
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>errors</span><a href="#errors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7575
<div class="tsd-signature"><span class="tsd-kind-property">errors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
7676
<ul>
77-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/json/validate-json.ts#L18">src/framework/util/json/validate-json.ts:18</a></li></ul></aside></section>
77+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/json/validate-json.ts#L18">src/framework/util/json/validate-json.ts:18</a></li></ul></aside></section>
7878
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
7979
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8080
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">

‎docs/classes/util.expr.Assign.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h4>Hierarchy</h4>
3030
<ul class="tsd-hierarchy">
3131
<li><span class="target">Assign</span></li></ul></li></ul></section><aside class="tsd-sources">
3232
<ul>
33-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L208">src/framework/util/expr/node.ts:208</a></li></ul></aside>
33+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L208">src/framework/util/expr/node.ts:208</a></li></ul></aside>
3434
<section class="tsd-panel-group tsd-index-group">
3535
<section class="tsd-panel tsd-index-panel">
3636
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -67,19 +67,19 @@ <h5><span class="tsd-kind-parameter">value</span>: <a href="util.expr.Node.html"
6767
<h4 class="tsd-returns-title">Returns <a href="util.expr.Assign.html" class="tsd-signature-type tsd-kind-class">Assign</a></h4><aside class="tsd-sources">
6868
<p>Overrides <a href="util.expr.Node.html">Node</a>.<a href="util.expr.Node.html#constructor">constructor</a></p>
6969
<ul>
70-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L209">src/framework/util/expr/node.ts:209</a></li></ul></aside></li></ul></section></section>
70+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L209">src/framework/util/expr/node.ts:209</a></li></ul></aside></li></ul></section></section>
7171
<section class="tsd-panel-group tsd-member-group">
7272
<h2>Properties</h2>
7373
<section class="tsd-panel tsd-member"><a id="target" class="tsd-anchor"></a>
7474
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>target</span><a href="#target" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7575
<div class="tsd-signature"><span class="tsd-kind-property">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">NameRef</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">PropertyRef</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">IndexRef</span></div><aside class="tsd-sources">
7676
<ul>
77-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L210">src/framework/util/expr/node.ts:210</a></li></ul></aside></section>
77+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L210">src/framework/util/expr/node.ts:210</a></li></ul></aside></section>
7878
<section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a>
7979
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>value</span><a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8080
<div class="tsd-signature"><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <a href="util.expr.Node.html" class="tsd-signature-type tsd-kind-class">Node</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
8181
<ul>
82-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L211">src/framework/util/expr/node.ts:211</a></li></ul></aside></section></section>
82+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L211">src/framework/util/expr/node.ts:211</a></li></ul></aside></section></section>
8383
<section class="tsd-panel-group tsd-member-group">
8484
<h2>Methods</h2>
8585
<section class="tsd-panel tsd-member"><a id="eval" class="tsd-anchor"></a>
@@ -100,7 +100,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</
100100
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
101101
<p>Overrides <a href="util.expr.Node.html">Node</a>.<a href="util.expr.Node.html#eval">eval</a></p>
102102
<ul>
103-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L216">src/framework/util/expr/node.ts:216</a></li></ul></aside></li></ul></section>
103+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L216">src/framework/util/expr/node.ts:216</a></li></ul></aside></li></ul></section>
104104
<section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a>
105105
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
106106
<ul class="tsd-signatures">
@@ -113,7 +113,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
113113
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
114114
<p>Overrides <a href="util.expr.Node.html">Node</a>.<a href="util.expr.Node.html#toString">toString</a></p>
115115
<ul>
116-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L243">src/framework/util/expr/node.ts:243</a></li></ul></aside></li></ul></section></section></div>
116+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L243">src/framework/util/expr/node.ts:243</a></li></ul></aside></li></ul></section></section></div>
117117
<div class="col-sidebar">
118118
<div class="page-menu">
119119
<div class="tsd-navigation settings">

‎docs/classes/util.expr.Node.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h4>Hierarchy</h4>
3636
<ul class="tsd-hierarchy">
3737
<li><a href="util.expr.Assign.html" class="tsd-signature-type tsd-kind-class">Assign</a></li></ul></li></ul></section><aside class="tsd-sources">
3838
<ul>
39-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L23">src/framework/util/expr/node.ts:23</a></li></ul></aside>
39+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L23">src/framework/util/expr/node.ts:23</a></li></ul></aside>
4040
<section class="tsd-panel-group tsd-index-group">
4141
<section class="tsd-panel tsd-index-panel">
4242
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -83,7 +83,7 @@ <h5><span class="tsd-kind-parameter">ctx</span>: <a href="../types/util.expr.Eva
8383
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4>
8484
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
8585
<ul>
86-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L28">src/framework/util/expr/node.ts:28</a></li></ul></aside></li></ul></section>
86+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L28">src/framework/util/expr/node.ts:28</a></li></ul></aside></li></ul></section>
8787
<section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a>
8888
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8989
<ul class="tsd-signatures">
@@ -95,7 +95,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code
9595
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
9696
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
9797
<ul>
98-
<li>Defined in <a href="https://github.com/forman/extend-me/blob/d634c89/src/framework/util/expr/node.ts#L34">src/framework/util/expr/node.ts:34</a></li></ul></aside></li></ul></section></section></div>
98+
<li>Defined in <a href="https://github.com/forman/extend-me/blob/2236f0c/src/framework/util/expr/node.ts#L34">src/framework/util/expr/node.ts:34</a></li></ul></aside></li></ul></section></section></div>
9999
<div class="col-sidebar">
100100
<div class="page-menu">
101101
<div class="tsd-navigation settings">

0 commit comments

Comments
 (0)