Skip to content

Commit

Permalink
typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Seanitzel
Seanitzel committed Apr 3, 2021
1 parent d3362b6 commit b813d52
Show file tree
Hide file tree
Showing 20 changed files with 1,954 additions and 2,690 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ npm install note-art
#### Music Models
The music models are pure music theory concepts that are translated to code.
* patterns are in semi-tones.

```
import {PitchClass, Note, Chord, Scale} from 'note-art'
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

40 changes: 17 additions & 23 deletions docs/classes/chord.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Chord | note-art</title>
<meta name="description" content="Documentation for note-art">
<title>Chord | Note-Art</title>
<meta name="description" content="Documentation for Note-Art">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<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">note-art</a>
<a href="../index.html" class="title">Note-Art</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">note-art</a>
<a href="../index.html">Note-Art</a>
</li>
<li>
<a href="chord.html">Chord</a>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="musicalpattern.html">MusicalPattern</a>.<a href="musicalpattern.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L14">theory/MusicalPattern.ts:14</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L14">theory/MusicalPattern.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>_info</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="musicalpattern.html">MusicalPattern</a>.<a href="musicalpattern.html#_info">_info</a></p>
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L11">theory/MusicalPattern.ts:11</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L11">theory/MusicalPattern.ts:11</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -197,7 +197,7 @@ <h3>_pitch<wbr>Classes</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="musicalpattern.html">MusicalPattern</a>.<a href="musicalpattern.html#_pitchclasses">_pitchClasses</a></p>
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L14">theory/MusicalPattern.ts:14</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L14">theory/MusicalPattern.ts:14</a></li>
</ul>
</aside>
</section>
Expand All @@ -214,7 +214,7 @@ <h3>info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L44">theory/MusicalPattern.ts:44</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L44">theory/MusicalPattern.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -241,7 +241,7 @@ <h3>pattern</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L52">theory/MusicalPattern.ts:52</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L52">theory/MusicalPattern.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -263,7 +263,7 @@ <h3>pitch<wbr>Classes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L28">theory/MusicalPattern.ts:28</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L28">theory/MusicalPattern.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -285,7 +285,7 @@ <h3>raw</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L60">theory/MusicalPattern.ts:60</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L60">theory/MusicalPattern.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -307,7 +307,7 @@ <h3>root</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L36">theory/MusicalPattern.ts:36</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L36">theory/MusicalPattern.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -332,7 +332,7 @@ <h3>inversion</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/Chord.ts#L22">theory/Chord.ts:22</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/Chord.ts#L22">theory/Chord.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -361,7 +361,7 @@ <h3>to<wbr>String</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="musicalpattern.html">MusicalPattern</a>.<a href="musicalpattern.html#tostring">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L68">theory/MusicalPattern.ts:68</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L68">theory/MusicalPattern.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -384,7 +384,7 @@ <h3>transpose</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="musicalpattern.html">MusicalPattern</a>.<a href="musicalpattern.html#transpose">transpose</a></p>
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/MusicalPattern.ts#L77">theory/MusicalPattern.ts:77</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/MusicalPattern.ts#L77">theory/MusicalPattern.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -411,7 +411,7 @@ <h4 class="tsd-returns-title">Returns <a href="musicalpattern.html" class="tsd-s
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
Expand Down Expand Up @@ -464,7 +464,7 @@ <h4 class="tsd-returns-title">Returns <a href="musicalpattern.html" class="tsd-s
</div>
</div>
</div>
<footer class="with-border-bottom">
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
Expand All @@ -479,18 +479,12 @@ <h2>Legend</h2>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
Expand Down
34 changes: 14 additions & 20 deletions docs/classes/guitarchordpattern.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>GuitarChordPattern | note-art</title>
<meta name="description" content="Documentation for note-art">
<title>GuitarChordPattern | Note-Art</title>
<meta name="description" content="Documentation for Note-Art">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<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">note-art</a>
<a href="../index.html" class="title">Note-Art</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">note-art</a>
<a href="../index.html">Note-Art</a>
</li>
<li>
<a href="guitarchordpattern.html">GuitarChordPattern</a>
Expand Down Expand Up @@ -139,7 +139,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L16">theory/GuitarChordPattern.ts:16</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L16">theory/GuitarChordPattern.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -167,7 +167,7 @@ <h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L16">theory/GuitarChordPattern.ts:16</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L16">theory/GuitarChordPattern.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -177,7 +177,7 @@ <h3>_pattern</h3>
<div class="tsd-signature tsd-kind-icon">_pattern<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L14">theory/GuitarChordPattern.ts:14</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L14">theory/GuitarChordPattern.ts:14</a></li>
</ul>
</aside>
</section>
Expand All @@ -187,7 +187,7 @@ <h3>_pitch<wbr>Class</h3>
<div class="tsd-signature tsd-kind-icon">_pitch<wbr>Class<span class="tsd-signature-symbol">:</span> <a href="pitchclass.html" class="tsd-signature-type" data-tsd-kind="Class">PitchClass</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L15">theory/GuitarChordPattern.ts:15</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L15">theory/GuitarChordPattern.ts:15</a></li>
</ul>
</aside>
</section>
Expand All @@ -204,7 +204,7 @@ <h3>name</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L44">theory/GuitarChordPattern.ts:44</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L44">theory/GuitarChordPattern.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -226,7 +226,7 @@ <h3>pattern</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L28">theory/GuitarChordPattern.ts:28</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L28">theory/GuitarChordPattern.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -248,7 +248,7 @@ <h3>pitch<wbr>Class</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L36">theory/GuitarChordPattern.ts:36</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L36">theory/GuitarChordPattern.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -273,7 +273,7 @@ <h3>get<wbr>Chord</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/dc44127/src/theory/GuitarChordPattern.ts#L53">theory/GuitarChordPattern.ts:53</a></li>
<li>Defined in <a href="https://github.com/Seanitzel/Note-Art/blob/d3362b6/src/theory/GuitarChordPattern.ts#L53">theory/GuitarChordPattern.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -308,7 +308,7 @@ <h5>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signatur
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
Expand Down Expand Up @@ -352,7 +352,7 @@ <h5>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signatur
</div>
</div>
</div>
<footer class="with-border-bottom">
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
Expand All @@ -367,18 +367,12 @@ <h2>Legend</h2>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
Expand Down
Loading

0 comments on commit b813d52

Please sign in to comment.