Skip to content

Commit

Permalink
links to source
Browse files Browse the repository at this point in the history
  • Loading branch information
vzakharov committed Oct 10, 2023
1 parent 10d0260 commit 0a5ed8d
Show file tree
Hide file tree
Showing 72 changed files with 88 additions and 85 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ For convenience, the package exports several handy functions demonstrating how y
- [`swotAnalysis`](https://losideadores.github.io/almostmagic2/functions/swotAnalysis.html) generates a SWOT analysis for a given idea, as an object with `strengths`, `weaknesses`, `opportunities`, and `threats` properties, each representing an array of strings.
- [`translate`](https://losideadores.github.io/almostmagic2/functions/translate.html) translates a given text from one language (doesn’t need specifying) to several other languages, as an object with keys corresponding to the requested target language codes and values corresponding to the translated text.

You can find the source code for each of these functions by following the links above and clicking the "Defined in" link in the bottom of the page.

## API reference

For complete documentation of every function, type, etc. exported by `almostmagic`, see the [API reference](https://losideadores.github.io/almostmagic2/modules.html).
8 changes: 4 additions & 4 deletions docs/classes/GenerateException.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><a href="SpecMismatchException.html" class="tsd-signature-type tsd-kind-class">SpecMismatchException</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateException.ts#L38">src/GenerateException.ts:38</a></li></ul></aside>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateException.ts#L38">src/GenerateException.ts:38</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -89,7 +89,7 @@ <h4 class="tsd-returns-title">Returns <a href="GenerateException.html" class="ts
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateException.ts#L45">src/GenerateException.ts:45</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateException.ts#L45">src/GenerateException.ts:45</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
Expand All @@ -105,7 +105,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateException.ts#L46">src/GenerateException.ts:46</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateException.ts#L46">src/GenerateException.ts:46</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
<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>
<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">
Expand All @@ -119,7 +119,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateException.ts#L47">src/GenerateException.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateException.ts#L47">src/GenerateException.ts:47</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/GenerateMeta.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">GenerateMeta</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateMeta.ts#L7">src/GenerateMeta.ts:7</a></li></ul></aside>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateMeta.ts#L7">src/GenerateMeta.ts:7</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -69,15 +69,15 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateMeta.ts#L9">src/GenerateMeta.ts:9</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateMeta.ts#L9">src/GenerateMeta.ts:9</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <a href="GenerateException.html" class="tsd-signature-type tsd-kind-class">GenerateException</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/GenerateExceptionType.html" class="tsd-signature-type tsd-kind-type-alias">GenerateExceptionType</a><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-comment tsd-typography"><p>Any error that occurred during the generation.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/GenerateMeta.ts#L16">src/GenerateMeta.ts:16</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/GenerateMeta.ts#L16">src/GenerateMeta.ts:16</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/Generator.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Generator</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/generator.ts#L9">src/generator.ts:9</a></li></ul></aside>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/generator.ts#L9">src/generator.ts:9</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -73,14 +73,14 @@ <h5><span class="tsd-kind-parameter">options</span>: <a href="../types/GenerateO
<h4 class="tsd-returns-title">Returns <a href="Generator.html" class="tsd-signature-type tsd-kind-class">Generator</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">O</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">I</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/generator.ts#L17">src/generator.ts:17</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/generator.ts#L17">src/generator.ts:17</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/GenerateOptionsBase.html" class="tsd-signature-type tsd-kind-type-alias">GenerateOptionsBase</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/generator.ts#L18">src/generator.ts:18</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/generator.ts#L18">src/generator.ts:18</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="generate" class="tsd-anchor"></a>
Expand Down Expand Up @@ -111,7 +111,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
<h4>See</h4><p><a href="../functions/generate.html" class="tsd-kind-function">generate</a> for more information.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/831f7c0/src/generator.ts#L24">src/generator.ts:24</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/losideadores/almostmagic2/blob/10d0260/src/generator.ts#L24">src/generator.ts:24</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 0a5ed8d

Please sign in to comment.