Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.

Commit

Permalink
chore: Update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
obany committed Apr 21, 2021
1 parent 42e307c commit cdb088e
Show file tree
Hide file tree
Showing 98 changed files with 1,388 additions and 1,369 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -1297,6 +1297,9 @@ module.exports = {
"unicorn/prefer-string-slice": [
"error"
],
"unicorn/prefer-switch": [
"off"
],
"unicorn/prefer-text-content": [
"error"
],
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@

# About

Experimental client library for IOTA Chrysalis network. Implemeted in TypeScript to strongly type the objects sent and received from the API.
> This library is functionally complete, but it is recommended to use [iota.rs](https://github.com/iotaledger/iota.rs). The rust library will be more heavily maintained and is much more performant.
Client library for IOTA Chrysalis network, implemeted in TypeScript to strongly type the objects sent and received from the API.

Also includes High Level operations and MQTT support.

Expand Down
12 changes: 6 additions & 6 deletions docs/classes/addresstypes_ed25519address.ed25519address.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ Create a new instance of Ed25519Address.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`publicKey` | *Uint8Array* | The public key for the address. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `publicKey` | *Uint8Array* | The public key for the address. |

**Returns:** [*Ed25519Address*](addresstypes_ed25519address.ed25519address.md)

Expand Down Expand Up @@ -61,9 +61,9 @@ Use the public key to validate the address.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`address` | *Uint8Array* | The address to verify. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `address` | *Uint8Array* | The address to verify. |

**Returns:** *boolean*

Expand Down
136 changes: 68 additions & 68 deletions docs/classes/clients_mqttclient.mqttclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ Create a new instace of MqttClient.

#### Parameters:

Name | Type | Default value | Description |
:------ | :------ | :------ | :------ |
`endpoints` | *string* \| *string*[] | - | The endpoint or endpoints list to connect to. |
`keepAliveTimeoutSeconds` | *number* | 30 | Timeout to reconnect if no messages received. |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `endpoints` | *string* \| *string*[] | - | The endpoint or endpoints list to connect to. |
| `keepAliveTimeoutSeconds` | *number* | 30 | Timeout to reconnect if no messages received. |

**Returns:** [*MqttClient*](clients_mqttclient.mqttclient.md)

Expand All @@ -63,10 +63,10 @@ Subscribe to the ed25519 address for output updates.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`addressEd25519` | *string* | The address to monitor. |
`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `addressEd25519` | *string* | The address to monitor. |
| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -84,10 +84,10 @@ Subscribe to the address for output updates.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`addressBech32` | *string* | The address to monitor. |
`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `addressBech32` | *string* | The address to monitor. |
| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -105,10 +105,10 @@ Subscribe to get all messages for the specified index in object form.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`index` | *string* \| *Uint8Array* | The index to monitor. |
`callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `index` | *string* \| *Uint8Array* | The index to monitor. |
| `callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -126,10 +126,10 @@ Subscribe to get all messages for the specified index in binary form.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`index` | *string* \| *Uint8Array* | The index to monitor. |
`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `index` | *string* \| *Uint8Array* | The index to monitor. |
| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -147,10 +147,10 @@ Subscribe to metadata updates for a specific message.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`messageId` | *string* | The message to monitor. |
`callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `messageId` | *string* | The message to monitor. |
| `callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -168,9 +168,9 @@ Subscribe to get all messages in object form.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -188,9 +188,9 @@ Subscribe to get the metadata for all the messages.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -208,9 +208,9 @@ Subscribe to get all messages in binary form.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -228,9 +228,9 @@ Subscribe to the latest confirmed milestone updates.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -248,9 +248,9 @@ Subscribe to the latest milestone updates.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -268,10 +268,10 @@ Subscribe to updates for a specific output.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`outputId` | *string* | The output to monitor. |
`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `outputId` | *string* | The output to monitor. |
| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -289,9 +289,9 @@ Subscribe to changes in the client state.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`callback` | (`data`: [*IMqttStatus*](../interfaces/models_imqttstatus.imqttstatus.md)) => *void* | Callback called when the state has changed. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | (`data`: [*IMqttStatus*](../interfaces/models_imqttstatus.imqttstatus.md)) => *void* | Callback called when the state has changed. |

**Returns:** *string*

Expand All @@ -309,16 +309,16 @@ Subscribe to another type of message as json.

#### Type parameters:

Name |
:------ |
`T` |
| Name |
| :------ |
| `T` |

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`customTopic` | *string* | The topic to subscribe to. |
`callback` | (`topic`: *string*, `data`: T) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `customTopic` | *string* | The topic to subscribe to. |
| `callback` | (`topic`: *string*, `data`: T) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -336,10 +336,10 @@ Subscribe to another type of message as raw data.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`customTopic` | *string* | The topic to subscribe to. |
`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `customTopic` | *string* | The topic to subscribe to. |
| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -357,10 +357,10 @@ Subscribe to message updates for a specific transactionId.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`transactionId` | *string* | The message to monitor. |
`callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `transactionId` | *string* | The message to monitor. |
| `callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -378,10 +378,10 @@ Subscribe to message updates for a specific transactionId.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`transactionId` | *string* | The message to monitor. |
`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `transactionId` | *string* | The message to monitor. |
| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. |

**Returns:** *string*

Expand All @@ -399,9 +399,9 @@ Remove a subscription.

#### Parameters:

Name | Type | Description |
:------ | :------ | :------ |
`subscriptionId` | *string* | The subscription to remove. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `subscriptionId` | *string* | The subscription to remove. |

**Returns:** *void*

Expand Down
Loading

0 comments on commit cdb088e

Please sign in to comment.