Skip to content

Commit

Permalink
refactor: output docs in HTML and readme in root folder
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrisbruford
chrisbruford committed Apr 29, 2018
1 parent 33f88c3 commit 0f3ef42
Show file tree
Hide file tree
Showing 193 changed files with 1,591 additions and 1,579 deletions.
21 changes: 13 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,23 @@ $ npm install cmdr-journal
Import the package into your project

```javascript
//ECMAScript
let cmdrJournal = require('cmdr-journal');
```
```javascript
//TypeScript
import * as cmdrJournal from 'cmdr-journal';
//Import the whole library
//CommonJS
const cj = require('cmdr-journal');
//ES2015
import cj from 'cmdr-journal';

//Or import just what you need
//CommonJS
const fsdJump = require('cmdr-journal').FSDJump;
//ES2015
import { FSDJump } from 'cmdr-journal';
```

Use the models and enums as you wish

```javascript
let interdiction = new cmdrJournal.Interdicton()
let interdiction = new cj.Interdicton()
```
## A note

Expand All @@ -36,4 +41,4 @@ Enums have been implemented with sensible names (where possible) and string valu

## Documentation

A full list of Classes and Enums available in this library can be found in [the docs folder](/docs/README.md)
A full list of Classes and Enums available in this library can be found in [the docs folder](/docs/index.html)
12 changes: 6 additions & 6 deletions docs/classes/afmurepairs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h3>Fully<wbr>Repaired</h3>
<div class="tsd-signature tsd-kind-icon">Fully<wbr>Repaired<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L544">models/journal-event.models.ts:544</a></li>
<li>Defined in models/journal-event.models.ts:544</li>
</ul>
</aside>
</section>
Expand All @@ -115,7 +115,7 @@ <h3>Health</h3>
<div class="tsd-signature tsd-kind-icon">Health<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L545">models/journal-event.models.ts:545</a></li>
<li>Defined in models/journal-event.models.ts:545</li>
</ul>
</aside>
</section>
Expand All @@ -125,7 +125,7 @@ <h3>Module</h3>
<div class="tsd-signature tsd-kind-icon">Module<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L542">models/journal-event.models.ts:542</a></li>
<li>Defined in models/journal-event.models.ts:542</li>
</ul>
</aside>
</section>
Expand All @@ -135,7 +135,7 @@ <h3>Module_<wbr><wbr>Localised</h3>
<div class="tsd-signature tsd-kind-icon">Module_<wbr><wbr>Localised<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L543">models/journal-event.models.ts:543</a></li>
<li>Defined in models/journal-event.models.ts:543</li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -157,7 +157,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/approachbody.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h3>Body</h3>
<div class="tsd-signature tsd-kind-icon">Body<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/approach-body.ts#L20">models/approach-body.ts:20</a></li>
<li>Defined in models/approach-body.ts:20</li>
</ul>
</aside>
</section>
Expand All @@ -130,7 +130,7 @@ <h3>BodyID</h3>
<div class="tsd-signature tsd-kind-icon">BodyID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/approach-body.ts#L21">models/approach-body.ts:21</a></li>
<li>Defined in models/approach-body.ts:21</li>
</ul>
</aside>
</section>
Expand All @@ -140,7 +140,7 @@ <h3>Star<wbr>System</h3>
<div class="tsd-signature tsd-kind-icon">Star<wbr>System<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/approach-body.ts#L18">models/approach-body.ts:18</a></li>
<li>Defined in models/approach-body.ts:18</li>
</ul>
</aside>
</section>
Expand All @@ -150,7 +150,7 @@ <h3>System<wbr>Address</h3>
<div class="tsd-signature tsd-kind-icon">System<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/approach-body.ts#L19">models/approach-body.ts:19</a></li>
<li>Defined in models/approach-body.ts:19</li>
</ul>
</aside>
</section>
Expand All @@ -161,7 +161,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -172,7 +172,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/approachsettlement.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ <h3>MarketID</h3>
<div class="tsd-signature tsd-kind-icon">MarketID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/approach-settlement.ts#L8">models/approach-settlement.ts:8</a></li>
<li>Defined in models/approach-settlement.ts:8</li>
</ul>
</aside>
</section>
Expand All @@ -120,7 +120,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/chrisbruford/cmdr-journal/blob/48605a1/src/models/approach-settlement.ts#L9">models/approach-settlement.ts:9</a></li>
<li>Defined in models/approach-settlement.ts:9</li>
</ul>
</aside>
</section>
Expand All @@ -131,7 +131,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -142,7 +142,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
14 changes: 7 additions & 7 deletions docs/classes/bounty.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3>Rewards</h3>
<div class="tsd-signature tsd-kind-icon">Rewards<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L114">models/journal-event.models.ts:114</a></li>
<li>Defined in models/journal-event.models.ts:114</li>
</ul>
</aside>
</section>
Expand All @@ -116,7 +116,7 @@ <h3>Shared<wbr>With<wbr>Others</h3>
<div class="tsd-signature tsd-kind-icon">Shared<wbr>With<wbr>Others<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L117">models/journal-event.models.ts:117</a></li>
<li>Defined in models/journal-event.models.ts:117</li>
</ul>
</aside>
</section>
Expand All @@ -126,7 +126,7 @@ <h3>Target</h3>
<div class="tsd-signature tsd-kind-icon">Target<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L118">models/journal-event.models.ts:118</a></li>
<li>Defined in models/journal-event.models.ts:118</li>
</ul>
</aside>
</section>
Expand All @@ -136,7 +136,7 @@ <h3>Total<wbr>Reward</h3>
<div class="tsd-signature tsd-kind-icon">Total<wbr>Reward<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L116">models/journal-event.models.ts:116</a></li>
<li>Defined in models/journal-event.models.ts:116</li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3>Victim<wbr>Faction</h3>
<div class="tsd-signature tsd-kind-icon">Victim<wbr>Faction<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L115">models/journal-event.models.ts:115</a></li>
<li>Defined in models/journal-event.models.ts:115</li>
</ul>
</aside>
</section>
Expand All @@ -157,7 +157,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +168,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/buyammo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>Cost</h3>
<div class="tsd-signature tsd-kind-icon">Cost<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L330">models/journal-event.models.ts:330</a></li>
<li>Defined in models/journal-event.models.ts:330</li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -124,7 +124,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/buydrones.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h3>Buy<wbr>Price</h3>
<div class="tsd-signature tsd-kind-icon">Buy<wbr>Price<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L337">models/journal-event.models.ts:337</a></li>
<li>Defined in models/journal-event.models.ts:337</li>
</ul>
</aside>
</section>
Expand All @@ -115,7 +115,7 @@ <h3>Count</h3>
<div class="tsd-signature tsd-kind-icon">Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L336">models/journal-event.models.ts:336</a></li>
<li>Defined in models/journal-event.models.ts:336</li>
</ul>
</aside>
</section>
Expand All @@ -125,7 +125,7 @@ <h3>Total<wbr>Cost</h3>
<div class="tsd-signature tsd-kind-icon">Total<wbr>Cost<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L338">models/journal-event.models.ts:338</a></li>
<li>Defined in models/journal-event.models.ts:338</li>
</ul>
</aside>
</section>
Expand All @@ -135,7 +135,7 @@ <h3>Type</h3>
<div class="tsd-signature tsd-kind-icon">Type<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L335">models/journal-event.models.ts:335</a></li>
<li>Defined in models/journal-event.models.ts:335</li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -157,7 +157,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/buyexplorationdata.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h3>Cost</h3>
<div class="tsd-signature tsd-kind-icon">Cost<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L230">models/journal-event.models.ts:230</a></li>
<li>Defined in models/journal-event.models.ts:230</li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3>System</h3>
<div class="tsd-signature tsd-kind-icon">System<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/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.models.ts#L229">models/journal-event.models.ts:229</a></li>
<li>Defined in models/journal-event.models.ts:229</li>
</ul>
</aside>
</section>
Expand All @@ -124,7 +124,7 @@ <h3>event</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#event">event</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L2">models/journal-event.model.ts:2</a></li>
<li>Defined in models/journal-event.model.ts:2</li>
</ul>
</aside>
</section>
Expand All @@ -135,7 +135,7 @@ <h3>timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="journalevent.html">JournalEvent</a>.<a href="journalevent.html#timestamp">timestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/chrisbruford/cmdr-journal/blob/48605a1/src/models/journal-event.model.ts#L3">models/journal-event.model.ts:3</a></li>
<li>Defined in models/journal-event.model.ts:3</li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 0f3ef42

Please sign in to comment.