Improved docs so minor changes don't update repo

iota-pico · Jun 28, 2018 · 06e4c28 · 06e4c28
1 parent f110434
commit 06e4c28
Show file tree

Hide file tree

Showing 35 changed files with 101 additions and 97 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@ node_modules
 *.tgz
 package-lock.*
 .nyc_output
-.vscode
+.vscode
+*.log
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - 9
+  - 10
 install:
   - cd ../../
   - git clone --branch=$TRAVIS_BRANCH https://github.com/iota-pico/core.git iota-pico/core

diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html
@@ -171,7 +171,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="prettify.js"></script>

diff --git a/coverage/lcov-report/src/error/businessError.ts.html b/coverage/lcov-report/src/error/businessError.ts.html
@@ -103,7 +103,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/error/index.html b/coverage/lcov-report/src/error/index.html
@@ -80,7 +80,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/helpers/addressHelper.ts.html b/coverage/lcov-report/src/helpers/addressHelper.ts.html
@@ -133,7 +133,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/helpers/bundleHelper.ts.html b/coverage/lcov-report/src/helpers/bundleHelper.ts.html
@@ -1210,7 +1210,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/helpers/index.html b/coverage/lcov-report/src/helpers/index.html
@@ -93,7 +93,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/index.html b/coverage/lcov-report/src/index.html
@@ -80,7 +80,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/index.ts.html b/coverage/lcov-report/src/index.ts.html
@@ -94,7 +94,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/interfaces/ITransactionClient.ts.html b/coverage/lcov-report/src/interfaces/ITransactionClient.ts.html
@@ -760,7 +760,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/interfaces/index.html b/coverage/lcov-report/src/interfaces/index.html
@@ -80,7 +80,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/multiSig/index.html b/coverage/lcov-report/src/multiSig/index.html
@@ -93,7 +93,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/multiSig/multiSigAddress.ts.html b/coverage/lcov-report/src/multiSig/multiSigAddress.ts.html
@@ -229,7 +229,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/multiSig/multiSigClient.ts.html b/coverage/lcov-report/src/multiSig/multiSigClient.ts.html
@@ -751,7 +751,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/sign/hmacCurl.ts.html b/coverage/lcov-report/src/sign/hmacCurl.ts.html
@@ -196,7 +196,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/sign/index.html b/coverage/lcov-report/src/sign/index.html
@@ -80,7 +80,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/transactions/index.html b/coverage/lcov-report/src/transactions/index.html
@@ -93,7 +93,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/transactions/proofOfWorkApi.ts.html b/coverage/lcov-report/src/transactions/proofOfWorkApi.ts.html
@@ -280,7 +280,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/transactions/transactionClient.ts.html b/coverage/lcov-report/src/transactions/transactionClient.ts.html
@@ -3394,7 +3394,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/types/accountData.ts.html b/coverage/lcov-report/src/types/accountData.ts.html
@@ -94,7 +94,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/types/index.html b/coverage/lcov-report/src/types/index.html
@@ -106,7 +106,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/types/promoteOptions.ts.html b/coverage/lcov-report/src/types/promoteOptions.ts.html
@@ -91,7 +91,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/coverage/lcov-report/src/types/transferOptions.ts.html b/coverage/lcov-report/src/types/transferOptions.ts.html
@@ -130,7 +130,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Wed Jun 27 2018 16:55:45 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
 </div>
 </div>
 <script src="..\..\prettify.js"></script>

diff --git a/docs/README.md b/docs/README.md
@@ -34,7 +34,7 @@
 
 **ΤAccountData**: *`object`*
 
-*Defined in [types/accountData.ts:8](https://github.com/iota-pico/business/blob/d578214/src/types/accountData.ts#L8)*
+*Defined in [types/accountData.ts:8](https://github.com/iota-pico/business/tree/master/src/types/accountData.ts#L8*
 
 Account data information returned from getAccountData.
 
@@ -57,7 +57,7 @@ ___
 
 **ΤPromoteOptions**: *`object`*
 
-*Defined in [types/promoteOptions.ts:4](https://github.com/iota-pico/business/blob/d578214/src/types/promoteOptions.ts#L4)*
+*Defined in [types/promoteOptions.ts:4](https://github.com/iota-pico/business/tree/master/src/types/promoteOptions.ts#L4*
 
 Options used during promote process in promoteTransaction.
 
@@ -78,7 +78,7 @@ ___
 
 **ΤTransferOptions**: *`object`*
 
-*Defined in [types/transferOptions.ts:9](https://github.com/iota-pico/business/blob/d578214/src/types/transferOptions.ts#L9)*
+*Defined in [types/transferOptions.ts:9](https://github.com/iota-pico/business/tree/master/src/types/transferOptions.ts#L9*
 
 Options used during prepare transfer process prepareTransfers and sendTransfer.
 

diff --git a/docs/classes/addresshelper.md b/docs/classes/addresshelper.md
@@ -25,7 +25,7 @@ Helper class for address signing. Original [https://github.com/iotaledger/iota.l
 
 ▸ **createChecksum**(trits: *`Int8Array`*, checksumLength: *`number`*): `string`
 
-*Defined in [helpers/addressHelper.ts:16](https://github.com/iota-pico/business/blob/d578214/src/helpers/addressHelper.ts#L16)*
+*Defined in [helpers/addressHelper.ts:16](https://github.com/iota-pico/business/tree/master/src/helpers/addressHelper.ts#L16*
 
 Create a checksum for the trits.
 

diff --git a/docs/classes/bundlehelper.md b/docs/classes/bundlehelper.md
@@ -33,7 +33,7 @@ Helper class for signing bundles. Converted [https://github.com/iotaledger/iota.
 
 **● NUMBER_OF_FRAGMENT_CHUNKS**: *`number`* = 27
 
-*Defined in [helpers/bundleHelper.ts:26](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L26)*
+*Defined in [helpers/bundleHelper.ts:26](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L26*
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 ▸ **finalizeBundle**(bundle: *`Bundle`*): `void`
 
-*Defined in [helpers/bundleHelper.ts:341](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L341)*
+*Defined in [helpers/bundleHelper.ts:341](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L341*
 
 Finalize a bundle.
 
@@ -64,7 +64,7 @@ ___
 
 ▸ **isValid**(bundle: *`Bundle`*): `boolean`
 
-*Defined in [helpers/bundleHelper.ts:33](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L33)*
+*Defined in [helpers/bundleHelper.ts:33](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L33*
 
 Is the bundle valid.
 
@@ -84,7 +84,7 @@ ___
 
 ▸ **prepareBundle**(timeService: *`ITimeService`*, transfers: *`Transfer`[]*): `object`
 
-*Defined in [helpers/bundleHelper.ts:166](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L166)*
+*Defined in [helpers/bundleHelper.ts:166](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L166*
 
 Prepare a bundle.
 
@@ -105,7 +105,7 @@ ___
 
 ▸ **signInputs**(seed: *`Hash`*, bundle: *`Bundle`*, transferOptions: *[TransferOptions](../#transferoptions)*, signatureMessageFragments: *`SignatureMessageFragment`[]*, inputs: *`Input`[]*, addedHMAC: *`boolean`*): `void`
 
-*Defined in [helpers/bundleHelper.ts:238](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L238)*
+*Defined in [helpers/bundleHelper.ts:238](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L238*
 
 Sign the input of the bundle.
 
@@ -129,7 +129,7 @@ ___
 
 ▸ **signTransactions**(bundle: *`Bundle`*, index: *`number`*, firstUnsignedIndex: *`number`*, keyTrits: *`Int8Array`*, addressTrytes: *`string`*, security: *`AddressSecurity`*): `void`
 
-*Defined in [helpers/bundleHelper.ts:289](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L289)*
+*Defined in [helpers/bundleHelper.ts:289](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L289*
 
 Sign the trsnactions
 
@@ -153,7 +153,7 @@ ___
 
 ▸ **validateSignatures**(signedBundle: *`Bundle`*, inputAddress: *`Address`*): `boolean`
 
-*Defined in [helpers/bundleHelper.ts:129](https://github.com/iota-pico/business/blob/d578214/src/helpers/bundleHelper.ts#L129)*
+*Defined in [helpers/bundleHelper.ts:129](https://github.com/iota-pico/business/tree/master/src/helpers/bundleHelper.ts#L129*
 
 Validate signatures for each of the co-signers in the multi-signature to independently verify that a generated transaction with the corresponding signatures of the co-signers is valid.
 

diff --git a/docs/classes/businesserror.md b/docs/classes/businesserror.md
@@ -42,7 +42,7 @@ A business implementation of an error.
 
 *Overrides CoreError.__constructor*
 
-*Defined in [error/businessError.ts:6](https://github.com/iota-pico/business/blob/d578214/src/error/businessError.ts#L6)*
+*Defined in [error/businessError.ts:6](https://github.com/iota-pico/business/tree/master/src/error/businessError.ts#L6*
 
 Create an instance of BusinessError.
 

diff --git a/docs/classes/hmaccurl.md b/docs/classes/hmaccurl.md
@@ -28,7 +28,7 @@ Hashed Message Authentication Code using Curl.
 
 ⊕ **new HmacCurl**(key: *`Trytes`*): [HmacCurl](hmaccurl.md)
 
-*Defined in [sign/hmacCurl.ts:14](https://github.com/iota-pico/business/blob/d578214/src/sign/hmacCurl.ts#L14)*
+*Defined in [sign/hmacCurl.ts:14](https://github.com/iota-pico/business/tree/master/src/sign/hmacCurl.ts#L14*
 
 Create a new instance of the HmacCurl.
 
@@ -50,7 +50,7 @@ ___
 
 ▸ **addHMAC**(bundle: *`Bundle`*): `void`
 
-*Defined in [sign/hmacCurl.ts:28](https://github.com/iota-pico/business/blob/d578214/src/sign/hmacCurl.ts#L28)*
+*Defined in [sign/hmacCurl.ts:28](https://github.com/iota-pico/business/tree/master/src/sign/hmacCurl.ts#L28*
 
 Add bundle to the HMAC.
 

diff --git a/docs/classes/multisigaddress.md b/docs/classes/multisigaddress.md
@@ -29,7 +29,7 @@ Address using multiple signatures.
 
 ⊕ **new MultiSigAddress**(): [MultiSigAddress](multisigaddress.md)
 
-*Defined in [multiSig/multiSigAddress.ts:18](https://github.com/iota-pico/business/blob/d578214/src/multiSig/multiSigAddress.ts#L18)*
+*Defined in [multiSig/multiSigAddress.ts:18](https://github.com/iota-pico/business/tree/master/src/multiSig/multiSigAddress.ts#L18*
 
 Create a new instance of the MultiSigAddress.
 
@@ -45,7 +45,7 @@ ___
 
 ▸ **absorb**(digests: *`Trytes`[]*): `void`
 
-*Defined in [multiSig/multiSigAddress.ts:33](https://github.com/iota-pico/business/blob/d578214/src/multiSig/multiSigAddress.ts#L33)*
+*Defined in [multiSig/multiSigAddress.ts:33](https://github.com/iota-pico/business/tree/master/src/multiSig/multiSigAddress.ts#L33*
 
 Absorb key digests.
 
@@ -64,7 +64,7 @@ ___
 
 ▸ **finalize**(digests?: *`Trytes`[]*): `Address`
 
-*Defined in [multiSig/multiSigAddress.ts:49](https://github.com/iota-pico/business/blob/d578214/src/multiSig/multiSigAddress.ts#L49)*
+*Defined in [multiSig/multiSigAddress.ts:49](https://github.com/iota-pico/business/tree/master/src/multiSig/multiSigAddress.ts#L49*
 
 Finalizes and returns the multisig address in trytes.