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

Commit cdb088e

Browse files
obanyobany
committed
chore: Update dependencies
1 parent 42e307c commit cdb088e

File tree

98 files changed

+1388
-1369
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1388
-1369
lines changed

‎.eslintrc.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1297,6 +1297,9 @@ module.exports = {
12971297
"unicorn/prefer-string-slice": [
12981298
"error"
12991299
],
1300+
"unicorn/prefer-switch": [
1301+
"off"
1302+
],
13001303
"unicorn/prefer-text-content": [
13011304
"error"
13021305
],

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@
2222

2323
# About
2424

25-
Experimental client library for IOTA Chrysalis network. Implemeted in TypeScript to strongly type the objects sent and received from the API.
25+
> 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.
26+
27+
Client library for IOTA Chrysalis network, implemeted in TypeScript to strongly type the objects sent and received from the API.
2628

2729
Also includes High Level operations and MQTT support.
2830

‎docs/classes/addresstypes_ed25519address.ed25519address.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Create a new instance of Ed25519Address.
3131

3232
#### Parameters:
3333

34-
Name | Type | Description |
35-
:------ | :------ | :------ |
36-
`publicKey` | *Uint8Array* | The public key for the address. |
34+
| Name | Type | Description |
35+
| :------ | :------ | :------ |
36+
| `publicKey` | *Uint8Array* | The public key for the address. |
3737

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

@@ -61,9 +61,9 @@ Use the public key to validate the address.
6161

6262
#### Parameters:
6363

64-
Name | Type | Description |
65-
:------ | :------ | :------ |
66-
`address` | *Uint8Array* | The address to verify. |
64+
| Name | Type | Description |
65+
| :------ | :------ | :------ |
66+
| `address` | *Uint8Array* | The address to verify. |
6767

6868
**Returns:** *boolean*
6969

‎docs/classes/clients_mqttclient.mqttclient.md‎

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ Create a new instace of MqttClient.
4646

4747
#### Parameters:
4848

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

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

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

6464
#### Parameters:
6565

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

7171
**Returns:** *string*
7272

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

8585
#### Parameters:
8686

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

9292
**Returns:** *string*
9393

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

106106
#### Parameters:
107107

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

113113
**Returns:** *string*
114114

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

127127
#### Parameters:
128128

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

134134
**Returns:** *string*
135135

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

148148
#### Parameters:
149149

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

155155
**Returns:** *string*
156156

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

169169
#### Parameters:
170170

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

175175
**Returns:** *string*
176176

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

189189
#### Parameters:
190190

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

195195
**Returns:** *string*
196196

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

209209
#### Parameters:
210210

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

215215
**Returns:** *string*
216216

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

229229
#### Parameters:
230230

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

235235
**Returns:** *string*
236236

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

249249
#### Parameters:
250250

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

255255
**Returns:** *string*
256256

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

269269
#### Parameters:
270270

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

276276
**Returns:** *string*
277277

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

290290
#### Parameters:
291291

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

296296
**Returns:** *string*
297297

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

310310
#### Type parameters:
311311

312-
Name |
313-
:------ |
314-
`T` |
312+
| Name |
313+
| :------ |
314+
| `T` |
315315

316316
#### Parameters:
317317

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

323323
**Returns:** *string*
324324

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

337337
#### Parameters:
338338

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

344344
**Returns:** *string*
345345

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

358358
#### Parameters:
359359

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

365365
**Returns:** *string*
366366

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

379379
#### Parameters:
380380

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

386386
**Returns:** *string*
387387

@@ -399,9 +399,9 @@ Remove a subscription.
399399

400400
#### Parameters:
401401

402-
Name | Type | Description |
403-
:------ | :------ | :------ |
404-
`subscriptionId` | *string* | The subscription to remove. |
402+
| Name | Type | Description |
403+
| :------ | :------ | :------ |
404+
| `subscriptionId` | *string* | The subscription to remove. |
405405

406406
**Returns:** *void*
407407

0 commit comments

Comments
 (0)