@iota-pico/pow-box - npm Package Compare versions

Comparing version 0.9.3 to 0.9.4

CHANGELOG.md

 # Changelog
 
+## v0.9.4
+
+* Fixed repo links in readme and coverage config
+
 ## v0.9.3
@@ -4,0 +8,0 @@

docs/classes/proofofworkbox.md

@@ -32,6 +32,8 @@ [@iota-pico/pow-box](../README.md) > [ProofOfWorkBox](../classes/proofofworkbox.md)
 
-### ⊕ **new ProofOfWorkBox**(networkClient: *`INetworkClient`*, apiKey: *`string`*, pollIntervalMs?: *`number`*): [ProofOfWorkBox](proofofworkbox.md)
+###  constructor
 
-*Defined in [proofOfWorkBox.ts:23](https://github.com/iota-pico/pow-box/blob/4585bac/src/proofOfWorkBox.ts#L23)*
+⊕ **new ProofOfWorkBox**(networkClient: *`INetworkClient`*, apiKey: *`string`*, pollIntervalMs?: *`number`*): [ProofOfWorkBox](proofofworkbox.md)
 
+*Defined in [proofOfWorkBox.ts:23](https://github.com/iota-pico/pow-box/blob/bad4355/src/proofOfWorkBox.ts#L23)*
+
 Create an instance of ProofOfWork.
@@ -43,9 +45,9 @@
 | ------ | ------ | ------ | ------ |
-| networkClient | `INetworkClient`  | - |   The network client to communicate through. |
-| apiKey | `string`  | - |   The API key to access the pow box. |
-| pollIntervalMs | `number`  | 1000 |   The polling time to check for completion. |
+| networkClient | `INetworkClient` | - |  The network client to communicate through. |
+| apiKey | `string` | - |  The API key to access the pow box. |
+| `Default value` pollIntervalMs | `number` | 1000 |  The polling time to check for completion. |
 
 **Returns:** [ProofOfWorkBox](proofofworkbox.md)
 
----
+___
 
@@ -58,13 +60,12 @@ ## Methods
 
-▸ **initialize**(): `Promise`.<`void`>
+▸ **initialize**(): `Promise`<`void`>
 
-*Defined in [proofOfWorkBox.ts:51](https://github.com/iota-pico/pow-box/blob/4585bac/src/proofOfWorkBox.ts#L51)*
+*Defined in [proofOfWorkBox.ts:51](https://github.com/iota-pico/pow-box/blob/bad4355/src/proofOfWorkBox.ts#L51)*
 
 Allow the proof of work to perform any initialization. Will throw an exception if the implementation is not supported.
 
-**Returns:** `Promise`.<`void`>
+**Returns:** `Promise`<`void`>
 Promise.
 
 ___
-
 <a id="pow"></a>
@@ -74,5 +75,5 @@
 
-▸ **pow**(trunkTransaction: *`Hash`*, branchTransaction: *`Hash`*, trytes: *`Trytes`[]*, minWeightMagnitude: *`number`*): `Promise`.<`Trytes`[]>
+▸ **pow**(trunkTransaction: *`Hash`*, branchTransaction: *`Hash`*, trytes: *`Trytes`[]*, minWeightMagnitude: *`number`*): `Promise`<`Trytes`[]>
 
-*Defined in [proofOfWorkBox.ts:63](https://github.com/iota-pico/pow-box/blob/4585bac/src/proofOfWorkBox.ts#L63)*
+*Defined in [proofOfWorkBox.ts:63](https://github.com/iota-pico/pow-box/blob/bad4355/src/proofOfWorkBox.ts#L63)*
 
@@ -85,8 +86,8 @@ Perform a proof of work on the data.
 | ------ | ------ | ------ |
-| trunkTransaction | `Hash`   |  The trunkTransaction to use for the pow. |
-| branchTransaction | `Hash`   |  The branchTransaction to use for the pow. |
-| trytes | `Trytes`[]   |  The trytes to perform the pow on. |
-| minWeightMagnitude | `number`   |  The minimum weight magnitude. |
+| trunkTransaction | `Hash` |  The trunkTransaction to use for the pow. |
+| branchTransaction | `Hash` |  The branchTransaction to use for the pow. |
+| trytes | `Trytes`[] |  The trytes to perform the pow on. |
+| minWeightMagnitude | `number` |  The minimum weight magnitude. |
 
-**Returns:** `Promise`.<`Trytes`[]>
+**Returns:** `Promise`<`Trytes`[]>
 The trytes produced by the proof of work.
@@ -93,0 +94,0 @@

docs/interfaces/iattachtotanglerequest.md

@@ -30,5 +30,5 @@ [@iota-pico/pow-box](../README.md) > [IAttachToTangleRequest](../interfaces/iattachtotanglerequest.md)
 
-**●  branchTransaction**:  *`string`* 
+**● branchTransaction**: *`string`*
 
-*Defined in [models/IAttachToTangleRequest.ts:15](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IAttachToTangleRequest.ts#L15)*
+*Defined in [models/IAttachToTangleRequest.ts:15](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IAttachToTangleRequest.ts#L15)*
 
@@ -38,3 +38,2 @@ Branch transaction to approve.
 ___
-
 <a id="command"></a>
@@ -44,5 +43,5 @@
 
-**●  command**:  *`string`* 
+**● command**: *`string`*
 
-*Defined in [models/IAttachToTangleRequest.ts:7](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IAttachToTangleRequest.ts#L7)*
+*Defined in [models/IAttachToTangleRequest.ts:7](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IAttachToTangleRequest.ts#L7)*
 
@@ -52,3 +51,2 @@ The command to send
 ___
-
 <a id="minweightmagnitude"></a>
@@ -58,5 +56,5 @@
 
-**●  minWeightMagnitude**:  *`number`* 
+**● minWeightMagnitude**: *`number`*
 
-*Defined in [models/IAttachToTangleRequest.ts:19](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IAttachToTangleRequest.ts#L19)*
+*Defined in [models/IAttachToTangleRequest.ts:19](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IAttachToTangleRequest.ts#L19)*
 
@@ -66,3 +64,2 @@ Proof of Work intensity. Minimum value is 18
 ___
-
 <a id="trunktransaction"></a>
@@ -72,5 +69,5 @@
 
-**●  trunkTransaction**:  *`string`* 
+**● trunkTransaction**: *`string`*
 
-*Defined in [models/IAttachToTangleRequest.ts:11](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IAttachToTangleRequest.ts#L11)*
+*Defined in [models/IAttachToTangleRequest.ts:11](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IAttachToTangleRequest.ts#L11)*
 
@@ -80,3 +77,2 @@ Trunk transaction to approve.
 ___
-
 <a id="trytes"></a>
@@ -86,5 +82,5 @@
 
-**●  trytes**:  *`string`[]* 
+**● trytes**: *`string`[]*
 
-*Defined in [models/IAttachToTangleRequest.ts:23](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IAttachToTangleRequest.ts#L23)*
+*Defined in [models/IAttachToTangleRequest.ts:23](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IAttachToTangleRequest.ts#L23)*
 
@@ -91,0 +87,0 @@ List of trytes (raw transaction data) to attach to the tangle.

docs/interfaces/iattachtotangleresponse.md

@@ -26,5 +26,5 @@ [@iota-pico/pow-box](../README.md) > [IAttachToTangleResponse](../interfaces/iattachtotangleresponse.md)
 
-**●  jobId**:  *`string`* 
+**● jobId**: *`string`*
 
-*Defined in [models/IAttachToTangleResponse.ts:9](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IAttachToTangleResponse.ts#L9)*
+*Defined in [models/IAttachToTangleResponse.ts:9](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IAttachToTangleResponse.ts#L9)*
 
@@ -31,0 +31,0 @@ The id of the job we can use to get progress.

docs/interfaces/ijobresponse.md

@@ -32,5 +32,5 @@ [@iota-pico/pow-box](../README.md) > [IJobResponse](../interfaces/ijobresponse.md)
 
-**●  createdAt**:  *`string`* 
+**● createdAt**: *`string`*
 
-*Defined in [models/IJobResponse.ts:19](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L19)*
+*Defined in [models/IJobResponse.ts:19](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L19)*
 
@@ -40,3 +40,2 @@ The date/time for job was created.
 ___
-
 <a id="error"></a>
@@ -46,5 +45,5 @@
 
-**●  error**:  *`boolean`* 
+**● error**: *`boolean`*
 
-*Defined in [models/IJobResponse.ts:24](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L24)*
+*Defined in [models/IJobResponse.ts:24](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L24)*
 
@@ -54,3 +53,2 @@ Was there an error for the job.
 ___
-
 <a id="errormessage"></a>
@@ -60,5 +58,5 @@
 
-**●  errorMessage**:  *`string`* 
+**● errorMessage**: *`string`*
 
-*Defined in [models/IJobResponse.ts:29](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L29)*
+*Defined in [models/IJobResponse.ts:29](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L29)*
 
@@ -68,3 +66,2 @@ The error message for the job.
 ___
-
 <a id="jobid"></a>
@@ -74,5 +71,5 @@
 
-**●  jobId**:  *`string`* 
+**● jobId**: *`string`*
 
-*Defined in [models/IJobResponse.ts:9](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L9)*
+*Defined in [models/IJobResponse.ts:9](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L9)*
 
@@ -82,3 +79,2 @@ The id of the job.
 ___
-
 <a id="progress"></a>
@@ -88,5 +84,5 @@
 
-**●  progress**:  *`string`* 
+**● progress**: *`string`*
 
-*Defined in [models/IJobResponse.ts:34](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L34)*
+*Defined in [models/IJobResponse.ts:34](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L34)*
 
@@ -96,3 +92,2 @@ The progress for the job.
 ___
-
 <a id="response"></a>
@@ -102,5 +97,5 @@
 
-**●  response**:  *`object`* 
+**● response**: *`object`*
 
-*Defined in [models/IJobResponse.ts:39](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L39)*
+*Defined in [models/IJobResponse.ts:39](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L39)*
 
@@ -114,3 +109,2 @@ The response trytes that have has pow performed on them.
 ___
-
 <a id="updatedat"></a>
@@ -120,5 +114,5 @@
 
-**●  updatedAt**:  *`string`* 
+**● updatedAt**: *`string`*
 
-*Defined in [models/IJobResponse.ts:14](https://github.com/iota-pico/pow-box/blob/4585bac/src/models/IJobResponse.ts#L14)*
+*Defined in [models/IJobResponse.ts:14](https://github.com/iota-pico/pow-box/blob/bad4355/src/models/IJobResponse.ts#L14)*
 
@@ -125,0 +119,0 @@ The date/time for job was updated.

package.json

 {
     "name": "@iota-pico/pow-box",
-    "version": "0.9.3",
+    "version": "0.9.4",
     "description": "IOTA Pico Framework Proof Of Work Remote Box",
@@ -50,5 +50,5 @@ "typings": "dist/index.d.ts",
     "dependencies": {
-        "@iota-pico/core": "^0.9.3",
-        "@iota-pico/crypto": "^0.9.3",
-        "@iota-pico/data": "^0.9.3"
+        "@iota-pico/core": "^0.9.4",
+        "@iota-pico/crypto": "^0.9.4",
+        "@iota-pico/data": "^0.9.4"
     },
@@ -60,3 +60,3 @@ "devDependencies": {
         "@babel/runtime": "^7.0.0-beta.42",
-        "@types/chai": "^4.1.1",
+        "@types/chai": "^4.1.3",
         "@types/mocha": "^5.2.0",
@@ -76,4 +76,4 @@ "@types/sinon": "^4.3.1",
         "sinon": "^4.5.0",
-        "source-map-support": "^0.5.4",
-        "ts-node": "^5.0.1",
+        "source-map-support": "^0.5.5",
+        "ts-node": "^6.0.1",
         "tslint": "^5.9.1",
@@ -83,8 +83,8 @@ "tslint-eslint-rules": "^5.1.0",
         "typedoc": "^0.11.1",
-        "typedoc-plugin-markdown": "^1.1.4",
+        "typedoc-plugin-markdown": "^1.1.6",
         "typescript": "^2.8.3",
         "uglifyjs-webpack-plugin": "^1.2.5",
         "webpack": "^4.6.0",
-        "webpack-cli": "^2.0.14"
+        "webpack-cli": "^2.0.15"
     }
 }

README.md

@@ -1,3 +0,3 @@
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/https://github.com/iota-pico/pow-box/master/LICENSE) [![Build Status](https://travis-ci.org/https://github.com/iota-pico/pow-box.svg?branch=master)](https://travis-ci.org/https://github.com/iota-pico/pow-box) [![NSP Status](https://nodesecurity.io/orgs/https://github.com/iota-pico/projects/aeca070b-6a72-4106-a7fd-5be139a19716/badge)](https://nodesecurity.io/orgs/https://github.com/iota-pico/projects/aeca070b-6a72-4106-a7fd-5be139a19716)
-[![Coveralls](https://img.shields.io/coveralls/https://github.com/iota-pico/pow-box.svg)](https://coveralls.io/github/https://github.com/iota-pico/pow-box)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/iota-pico/pow-box/master/LICENSE) [![Build Status](https://travis-ci.org/iota-pico/pow-box.svg?branch=master)](https://travis-ci.org/iota-pico/pow-box) [![NSP Status](https://nodesecurity.io/orgs/iota-pico/projects/aeca070b-6a72-4106-a7fd-5be139a19716/badge)](https://nodesecurity.io/orgs/iota-pico/projects/aeca070b-6a72-4106-a7fd-5be139a19716)
+[![Coveralls](https://img.shields.io/coveralls/iota-pico/pow-box.svg)](https://coveralls.io/github/iota-pico/pow-box)
 
@@ -4,0 +4,0 @@ # IOTA Pico Framework Proof Of Work Remote Box

No alert changes

Worsened metrics

Total package byte prevSize

229986

decreased by-0.05%

Dependency changes

• Updated@iota-pico/core@^0.9.4

• Updated@iota-pico/crypto@^0.9.4

• Updated@iota-pico/data@^0.9.4