@iota-pico/core
Advanced tools
Comparing version 0.9.3 to 0.9.4
# Changelog | ||
## v0.9.4 | ||
* Fixed repo links in readme and coverage config | ||
## v0.9.3 | ||
@@ -4,0 +8,0 @@ |
@@ -29,3 +29,3 @@ [@iota-pico/core](../README.md) > [ArrayHelper](../classes/arrayhelper.md) | ||
*Defined in [helpers/arrayHelper.ts:12](https://github.com/iota-pico/core/blob/35412fd/src/helpers/arrayHelper.ts#L12)* | ||
*Defined in [helpers/arrayHelper.ts:12](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/arrayHelper.ts#L12)* | ||
@@ -38,3 +38,3 @@ Is the value an array. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test. | | ||
| value | `any` | Object to test. | | ||
@@ -45,3 +45,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isempty"></a> | ||
@@ -53,3 +52,3 @@ | ||
*Defined in [helpers/arrayHelper.ts:22](https://github.com/iota-pico/core/blob/35412fd/src/helpers/arrayHelper.ts#L22)* | ||
*Defined in [helpers/arrayHelper.ts:22](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/arrayHelper.ts#L22)* | ||
@@ -62,3 +61,3 @@ Is the value a empty array. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test. | | ||
| value | `any` | Object to test. | | ||
@@ -69,3 +68,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="istyped"></a> | ||
@@ -77,3 +75,3 @@ | ||
*Defined in [helpers/arrayHelper.ts:32](https://github.com/iota-pico/core/blob/35412fd/src/helpers/arrayHelper.ts#L32)* | ||
*Defined in [helpers/arrayHelper.ts:32](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/arrayHelper.ts#L32)* | ||
@@ -86,4 +84,4 @@ Is the value a non empty array of specific type. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test. | | ||
| type | `Function` | The type of the object | | ||
| value | `any` | Object to test. | | ||
| type | `Function` | The type of the object | | ||
@@ -90,0 +88,0 @@ **Returns:** `boolean` |
@@ -29,5 +29,5 @@ [@iota-pico/core](../README.md) > [BackgroundTaskService](../classes/backgroundtaskservice.md) | ||
▸ **create**T(task: *`function`*, delay: *`number`*): `Promise`.<`T`> | ||
▸ **create**T(task: *`function`*, delay: *`number`*): `Promise`<`T`> | ||
*Defined in [services/backgroundTaskService.ts:13](https://github.com/iota-pico/core/blob/35412fd/src/services/backgroundTaskService.ts#L13)* | ||
*Defined in [services/backgroundTaskService.ts:13](https://github.com/iota-pico/core/blob/0ebbbcc/src/services/backgroundTaskService.ts#L13)* | ||
@@ -43,6 +43,6 @@ Create a background task. | ||
| ------ | ------ | ------ | | ||
| task | `function` | The task to run in the background. | | ||
| delay | `number` | The delay before running the task. | | ||
| task | `function` | The task to run in the background. | | ||
| delay | `number` | The delay before running the task. | | ||
**Returns:** `Promise`.<`T`> | ||
**Returns:** `Promise`<`T`> | ||
The result of the background task. | ||
@@ -49,0 +49,0 @@ |
@@ -35,6 +35,8 @@ [@iota-pico/core](../README.md) > [ConsoleLogger](../classes/consolelogger.md) | ||
### ⊕ **new ConsoleLogger**(loggingObject?: *`Console`*): [ConsoleLogger](consolelogger.md) | ||
### constructor | ||
*Defined in [loggers/consoleLogger.ts:13](https://github.com/iota-pico/core/blob/35412fd/src/loggers/consoleLogger.ts#L13)* | ||
⊕ **new ConsoleLogger**(loggingObject?: *`Console`*): [ConsoleLogger](consolelogger.md) | ||
*Defined in [loggers/consoleLogger.ts:13](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/consoleLogger.ts#L13)* | ||
Create and instance of the console logger. | ||
@@ -46,3 +48,3 @@ | ||
| ------ | ------ | ------ | | ||
| loggingObject | `Console` | The object to send all the logging to. | | ||
| `Optional` loggingObject | `Console` | The object to send all the logging to. | | ||
@@ -52,3 +54,3 @@ **Returns:** [ConsoleLogger](consolelogger.md) | ||
--- | ||
___ | ||
@@ -65,3 +67,3 @@ ## Methods | ||
*Defined in [loggers/consoleLogger.ts:29](https://github.com/iota-pico/core/blob/35412fd/src/loggers/consoleLogger.ts#L29)* | ||
*Defined in [loggers/consoleLogger.ts:29](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/consoleLogger.ts#L29)* | ||
@@ -74,4 +76,4 @@ Send banner to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -81,3 +83,2 @@ **Returns:** `void` | ||
___ | ||
<a id="error"></a> | ||
@@ -91,3 +92,3 @@ | ||
*Defined in [loggers/consoleLogger.ts:72](https://github.com/iota-pico/core/blob/35412fd/src/loggers/consoleLogger.ts#L72)* | ||
*Defined in [loggers/consoleLogger.ts:72](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/consoleLogger.ts#L72)* | ||
@@ -100,5 +101,5 @@ Send error to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| err | `any` | An error object to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Optional` err | `any` | An error object to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -108,3 +109,2 @@ **Returns:** `void` | ||
___ | ||
<a id="info"></a> | ||
@@ -118,3 +118,3 @@ | ||
*Defined in [loggers/consoleLogger.ts:51](https://github.com/iota-pico/core/blob/35412fd/src/loggers/consoleLogger.ts#L51)* | ||
*Defined in [loggers/consoleLogger.ts:51](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/consoleLogger.ts#L51)* | ||
@@ -127,4 +127,4 @@ Send information to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -134,3 +134,2 @@ **Returns:** `void` | ||
___ | ||
<a id="log"></a> | ||
@@ -144,3 +143,3 @@ | ||
*Defined in [loggers/consoleLogger.ts:41](https://github.com/iota-pico/core/blob/35412fd/src/loggers/consoleLogger.ts#L41)* | ||
*Defined in [loggers/consoleLogger.ts:41](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/consoleLogger.ts#L41)* | ||
@@ -153,4 +152,4 @@ Send log to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -160,3 +159,2 @@ **Returns:** `void` | ||
___ | ||
<a id="warning"></a> | ||
@@ -170,3 +168,3 @@ | ||
*Defined in [loggers/consoleLogger.ts:61](https://github.com/iota-pico/core/blob/35412fd/src/loggers/consoleLogger.ts#L61)* | ||
*Defined in [loggers/consoleLogger.ts:61](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/consoleLogger.ts#L61)* | ||
@@ -179,4 +177,4 @@ Send warning to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -183,0 +181,0 @@ **Returns:** `void` |
@@ -44,6 +44,8 @@ [@iota-pico/core](../README.md) > [CoreError](../classes/coreerror.md) | ||
### ⊕ **new CoreError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [CoreError](coreerror.md) | ||
### constructor | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L21)* | ||
⊕ **new CoreError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [CoreError](coreerror.md) | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L21)* | ||
Create an instance of CoreError. | ||
@@ -55,9 +57,9 @@ | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message for the error. | | ||
| additional | `object` | Additional details about the error. | | ||
| innerError | `Error` | Add information from inner error if there was one. | | ||
| message | `string` | The message for the error. | | ||
| `Optional` additional | `object` | Additional details about the error. | | ||
| `Optional` innerError | `Error` | Add information from inner error if there was one. | | ||
**Returns:** [CoreError](coreerror.md) | ||
--- | ||
___ | ||
@@ -70,5 +72,5 @@ ## Properties | ||
**● additional**: *`object`* | ||
**● additional**: *`object`* | ||
*Defined in [error/coreError.ts:16](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L16)* | ||
*Defined in [error/coreError.ts:16](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L16)* | ||
@@ -82,3 +84,2 @@ Additional details about the error. | ||
___ | ||
<a id="domain"></a> | ||
@@ -88,5 +89,5 @@ | ||
**● domain**: *`string`* | ||
**● domain**: *`string`* | ||
*Defined in [error/coreError.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L11)* | ||
*Defined in [error/coreError.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L11)* | ||
@@ -96,3 +97,2 @@ The domain of the error. | ||
___ | ||
<a id="innererror"></a> | ||
@@ -102,5 +102,5 @@ | ||
**● innerError**: *`Error`* | ||
**● innerError**: *`Error`* | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L21)* | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L21)* | ||
@@ -110,3 +110,2 @@ The inner error if there was one. | ||
___ | ||
<a id="error"></a> | ||
@@ -116,3 +115,3 @@ | ||
**● Error**: *`ErrorConstructor`* | ||
**● Error**: *`ErrorConstructor`* | ||
@@ -122,3 +121,2 @@ *Defined in D:/Workarea/iota-pico/core/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:896* | ||
___ | ||
<a id="message"></a> | ||
@@ -128,3 +126,3 @@ | ||
**● message**: *`string`* | ||
**● message**: *`string`* | ||
@@ -136,3 +134,2 @@ *Inherited from Error.message* | ||
___ | ||
<a id="name"></a> | ||
@@ -142,3 +139,3 @@ | ||
**● name**: *`string`* | ||
**● name**: *`string`* | ||
@@ -150,3 +147,2 @@ *Inherited from Error.name* | ||
___ | ||
<a id="stack"></a> | ||
@@ -156,3 +152,3 @@ | ||
**● stack**: *`string`* | ||
**● stack**: *`string`* | ||
@@ -173,3 +169,3 @@ *Inherited from Error.stack* | ||
*Defined in [error/coreError.ts:49](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L49)* | ||
*Defined in [error/coreError.ts:49](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L49)* | ||
@@ -182,3 +178,2 @@ Format the error to a readable version. | ||
___ | ||
<a id="iserror"></a> | ||
@@ -190,3 +185,3 @@ | ||
*Defined in [error/coreError.ts:41](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L41)* | ||
*Defined in [error/coreError.ts:41](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L41)* | ||
@@ -199,3 +194,3 @@ Check if an object could be a CoreError. | ||
| ------ | ------ | ------ | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
@@ -202,0 +197,0 @@ **Returns:** `boolean` |
@@ -27,3 +27,3 @@ [@iota-pico/core](../README.md) > [ErrorHelper](../classes/errorhelper.md) | ||
*Defined in [helpers/errorHelper.ts:16](https://github.com/iota-pico/core/blob/35412fd/src/helpers/errorHelper.ts#L16)* | ||
*Defined in [helpers/errorHelper.ts:16](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/errorHelper.ts#L16)* | ||
@@ -36,4 +36,4 @@ Format an error object into something readable. | ||
| ------ | ------ | ------ | | ||
| err | `any` | The object to format. | | ||
| includeStack | `boolean` | Include the stack trace if there is one. | | ||
| err | `any` | The object to format. | | ||
| includeStack | `boolean` | Include the stack trace if there is one. | | ||
@@ -40,0 +40,0 @@ **Returns:** `string` |
@@ -43,3 +43,3 @@ [@iota-pico/core](../README.md) > [FactoryBase](../classes/factorybase.md) | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L50)* | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L50)* | ||
@@ -52,4 +52,4 @@ Create an instance of an object from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to create. | | ||
| args | `any`[] | Any parameters to pass to the constructor. | | ||
| name | `string` | The name of the type to create. | | ||
| `Rest` args | `any`[] | Any parameters to pass to the constructor. | | ||
@@ -60,3 +60,2 @@ **Returns:** `T` | ||
___ | ||
<a id="exists"></a> | ||
@@ -68,3 +67,3 @@ | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L31)* | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L31)* | ||
@@ -77,3 +76,3 @@ Does the factory contain a specific type. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to look for. | | ||
| name | `string` | The name of the type to look for. | | ||
@@ -84,3 +83,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="getinstance"></a> | ||
@@ -90,10 +88,9 @@ | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)`T` | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)<`T`> | ||
*Defined in [factories/factoryBase.ts:60](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L60)* | ||
*Defined in [factories/factoryBase.ts:60](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L60)* | ||
**Returns:** [FactoryBase](factorybase.md)`T` | ||
**Returns:** [FactoryBase](factorybase.md)<`T`> | ||
___ | ||
<a id="register"></a> | ||
@@ -105,3 +102,3 @@ | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L14)* | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L14)* | ||
@@ -114,4 +111,4 @@ Register a new type with the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
@@ -121,3 +118,2 @@ **Returns:** `void` | ||
___ | ||
<a id="types"></a> | ||
@@ -129,3 +125,3 @@ | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L40)* | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L40)* | ||
@@ -138,3 +134,2 @@ List the types in the factory. | ||
___ | ||
<a id="unregister"></a> | ||
@@ -146,3 +141,3 @@ | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L22)* | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L22)* | ||
@@ -155,3 +150,3 @@ Unregister a type from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to unregister. | | ||
| name | `string` | The name of the type to unregister. | | ||
@@ -158,0 +153,0 @@ **Returns:** `void` |
@@ -25,5 +25,5 @@ [@iota-pico/core](../README.md) > [JsonHelper](../classes/jsonhelper.md) | ||
▸ **stringify**(value: *`any`*, replacer?: *`function`*, space?: *`string`⎮`number`*): `string` | ||
▸ **stringify**(value: *`any`*, replacer?: *`function`*, space?: *`string` |`number`*): `string` | ||
*Defined in [helpers/jsonHelper.ts:12](https://github.com/iota-pico/core/blob/35412fd/src/helpers/jsonHelper.ts#L12)* | ||
*Defined in [helpers/jsonHelper.ts:12](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/jsonHelper.ts#L12)* | ||
@@ -36,5 +36,7 @@ Stringify an object with recursion breaking. | ||
| ------ | ------ | ------ | | ||
| value | `any` | A JavaScript value, usually an object or array, to be converted. | | ||
| replacer | `function` | A function that transforms the results. | | ||
| space | `string`⎮`number` | Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. | | ||
| value | `any` | A JavaScript value, usually an object or array, to be converted. | | ||
| `Optional` replacer | `function` | A function that transforms the results. | | ||
| `Optional` space | `string` | | ||
`number` | ||
| Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. | | ||
@@ -41,0 +43,0 @@ **Returns:** `string` |
@@ -9,3 +9,3 @@ [@iota-pico/core](../README.md) > [NetworkClientFactory](../classes/networkclientfactory.md) | ||
[FactoryBase](factorybase.md)[INetworkClient](../interfaces/inetworkclient.md) | ||
[FactoryBase](factorybase.md)<[INetworkClient](../interfaces/inetworkclient.md)> | ||
@@ -38,3 +38,3 @@ **↳ NetworkClientFactory** | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L50)* | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L50)* | ||
@@ -47,4 +47,4 @@ Create an instance of an object from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to create. | | ||
| args | `any`[] | Any parameters to pass to the constructor. | | ||
| name | `string` | The name of the type to create. | | ||
| `Rest` args | `any`[] | Any parameters to pass to the constructor. | | ||
@@ -55,3 +55,2 @@ **Returns:** [INetworkClient](../interfaces/inetworkclient.md) | ||
___ | ||
<a id="exists"></a> | ||
@@ -65,3 +64,3 @@ | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L31)* | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L31)* | ||
@@ -74,3 +73,3 @@ Does the factory contain a specific type. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to look for. | | ||
| name | `string` | The name of the type to look for. | | ||
@@ -81,3 +80,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="getinstance"></a> | ||
@@ -87,12 +85,11 @@ | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)[INetworkClient](../interfaces/inetworkclient.md) | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)<[INetworkClient](../interfaces/inetworkclient.md)> | ||
*Overrides [FactoryBase](factorybase.md).[getInstance](factorybase.md#getinstance)* | ||
*Defined in [factories/networkClientFactory.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/networkClientFactory.ts#L31)* | ||
*Defined in [factories/networkClientFactory.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/networkClientFactory.ts#L31)* | ||
**Returns:** [FactoryBase](factorybase.md)[INetworkClient](../interfaces/inetworkclient.md) | ||
**Returns:** [FactoryBase](factorybase.md)<[INetworkClient](../interfaces/inetworkclient.md)> | ||
___ | ||
<a id="register"></a> | ||
@@ -106,3 +103,3 @@ | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L14)* | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L14)* | ||
@@ -115,4 +112,4 @@ Register a new type with the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
@@ -122,3 +119,2 @@ **Returns:** `void` | ||
___ | ||
<a id="types"></a> | ||
@@ -132,3 +128,3 @@ | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L40)* | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L40)* | ||
@@ -141,3 +137,2 @@ List the types in the factory. | ||
___ | ||
<a id="unregister"></a> | ||
@@ -151,3 +146,3 @@ | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L22)* | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L22)* | ||
@@ -160,3 +155,3 @@ Unregister a type from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to unregister. | | ||
| name | `string` | The name of the type to unregister. | | ||
@@ -166,3 +161,2 @@ **Returns:** `void` | ||
___ | ||
<a id="instance"></a> | ||
@@ -172,9 +166,9 @@ | ||
▸ **instance**(): [FactoryBase](factorybase.md)[INetworkClient](../interfaces/inetworkclient.md) | ||
▸ **instance**(): [FactoryBase](factorybase.md)<[INetworkClient](../interfaces/inetworkclient.md)> | ||
*Defined in [factories/networkClientFactory.ts:23](https://github.com/iota-pico/core/blob/35412fd/src/factories/networkClientFactory.ts#L23)* | ||
*Defined in [factories/networkClientFactory.ts:23](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/networkClientFactory.ts#L23)* | ||
Get the instance of the factory. | ||
**Returns:** [FactoryBase](factorybase.md)[INetworkClient](../interfaces/inetworkclient.md) | ||
**Returns:** [FactoryBase](factorybase.md)<[INetworkClient](../interfaces/inetworkclient.md)> | ||
The factory instance. | ||
@@ -181,0 +175,0 @@ |
@@ -35,6 +35,8 @@ [@iota-pico/core](../README.md) > [NetworkEndPoint](../classes/networkendpoint.md) | ||
### ⊕ **new NetworkEndPoint**(protocol: *[NetworkProtocol](../#networkprotocol)*, host: *`string`*, port: *`number`*, rootPath?: *`string`*): [NetworkEndPoint](networkendpoint.md) | ||
### constructor | ||
*Defined in [network/networkEndPoint.ts:19](https://github.com/iota-pico/core/blob/35412fd/src/network/networkEndPoint.ts#L19)* | ||
⊕ **new NetworkEndPoint**(protocol: *[NetworkProtocol](../#networkprotocol)*, host: *`string`*, port: *`number`*, rootPath?: *`string`*): [NetworkEndPoint](networkendpoint.md) | ||
*Defined in [network/networkEndPoint.ts:19](https://github.com/iota-pico/core/blob/0ebbbcc/src/network/networkEndPoint.ts#L19)* | ||
Create an instance of NetworkEndPoint. | ||
@@ -46,10 +48,10 @@ | ||
| ------ | ------ | ------ | | ||
| protocol | [NetworkProtocol](../#networkprotocol) | The protocol to access the endpoint with. | | ||
| host | `string` | The host name or ip of the endpoint. | | ||
| port | `number` | The port of the endpoint. | | ||
| rootPath | `string` | The path to the endpoint. | | ||
| protocol | [NetworkProtocol](../#networkprotocol) | The protocol to access the endpoint with. | | ||
| host | `string` | The host name or ip of the endpoint. | | ||
| port | `number` | The port of the endpoint. | | ||
| `Optional` rootPath | `string` | The path to the endpoint. | | ||
**Returns:** [NetworkEndPoint](networkendpoint.md) | ||
--- | ||
___ | ||
@@ -66,3 +68,3 @@ ## Methods | ||
*Defined in [network/networkEndPoint.ts:59](https://github.com/iota-pico/core/blob/35412fd/src/network/networkEndPoint.ts#L59)* | ||
*Defined in [network/networkEndPoint.ts:59](https://github.com/iota-pico/core/blob/0ebbbcc/src/network/networkEndPoint.ts#L59)* | ||
@@ -75,3 +77,2 @@ The host name or ip of the endpoint. | ||
___ | ||
<a id="getport"></a> | ||
@@ -85,3 +86,3 @@ | ||
*Defined in [network/networkEndPoint.ts:75](https://github.com/iota-pico/core/blob/35412fd/src/network/networkEndPoint.ts#L75)* | ||
*Defined in [network/networkEndPoint.ts:75](https://github.com/iota-pico/core/blob/0ebbbcc/src/network/networkEndPoint.ts#L75)* | ||
@@ -94,3 +95,2 @@ The port of the endpoint. | ||
___ | ||
<a id="getprotocol"></a> | ||
@@ -104,3 +104,3 @@ | ||
*Defined in [network/networkEndPoint.ts:51](https://github.com/iota-pico/core/blob/35412fd/src/network/networkEndPoint.ts#L51)* | ||
*Defined in [network/networkEndPoint.ts:51](https://github.com/iota-pico/core/blob/0ebbbcc/src/network/networkEndPoint.ts#L51)* | ||
@@ -113,3 +113,2 @@ The protocol to access the endpoint with. | ||
___ | ||
<a id="getrootpath"></a> | ||
@@ -123,3 +122,3 @@ | ||
*Defined in [network/networkEndPoint.ts:67](https://github.com/iota-pico/core/blob/35412fd/src/network/networkEndPoint.ts#L67)* | ||
*Defined in [network/networkEndPoint.ts:67](https://github.com/iota-pico/core/blob/0ebbbcc/src/network/networkEndPoint.ts#L67)* | ||
@@ -132,3 +131,2 @@ The path to the endpoint. | ||
___ | ||
<a id="geturi"></a> | ||
@@ -142,3 +140,3 @@ | ||
*Defined in [network/networkEndPoint.ts:83](https://github.com/iota-pico/core/blob/35412fd/src/network/networkEndPoint.ts#L83)* | ||
*Defined in [network/networkEndPoint.ts:83](https://github.com/iota-pico/core/blob/0ebbbcc/src/network/networkEndPoint.ts#L83)* | ||
@@ -145,0 +143,0 @@ The complete uri. |
@@ -39,7 +39,9 @@ [@iota-pico/core](../README.md) > [NetworkError](../classes/networkerror.md) | ||
### ⊕ **new NetworkError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [NetworkError](networkerror.md) | ||
### constructor | ||
⊕ **new NetworkError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [NetworkError](networkerror.md) | ||
*Overrides [CoreError](coreerror.md).[constructor](coreerror.md#constructor)* | ||
*Defined in [error/networkError.ts:6](https://github.com/iota-pico/core/blob/35412fd/src/error/networkError.ts#L6)* | ||
*Defined in [error/networkError.ts:6](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/networkError.ts#L6)* | ||
@@ -52,9 +54,9 @@ Create an instance of NetworkError. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message for the error. | | ||
| additional | `object` | Additional details about the error. | | ||
| innerError | `Error` | Add information from inner error if there was one. | | ||
| message | `string` | The message for the error. | | ||
| `Optional` additional | `object` | Additional details about the error. | | ||
| `Optional` innerError | `Error` | Add information from inner error if there was one. | | ||
**Returns:** [NetworkError](networkerror.md) | ||
--- | ||
___ | ||
@@ -67,7 +69,7 @@ ## Properties | ||
**● additional**: *`object`* | ||
**● additional**: *`object`* | ||
*Inherited from [CoreError](coreerror.md).[additional](coreerror.md#additional)* | ||
*Defined in [error/coreError.ts:16](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L16)* | ||
*Defined in [error/coreError.ts:16](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L16)* | ||
@@ -81,3 +83,2 @@ Additional details about the error. | ||
___ | ||
<a id="domain"></a> | ||
@@ -87,7 +88,7 @@ | ||
**● domain**: *`string`* | ||
**● domain**: *`string`* | ||
*Inherited from [CoreError](coreerror.md).[domain](coreerror.md#domain)* | ||
*Defined in [error/coreError.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L11)* | ||
*Defined in [error/coreError.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L11)* | ||
@@ -97,3 +98,2 @@ The domain of the error. | ||
___ | ||
<a id="innererror"></a> | ||
@@ -103,7 +103,7 @@ | ||
**● innerError**: *`Error`* | ||
**● innerError**: *`Error`* | ||
*Inherited from [CoreError](coreerror.md).[innerError](coreerror.md#innererror)* | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L21)* | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L21)* | ||
@@ -113,3 +113,2 @@ The inner error if there was one. | ||
___ | ||
<a id="message"></a> | ||
@@ -119,3 +118,3 @@ | ||
**● message**: *`string`* | ||
**● message**: *`string`* | ||
@@ -127,3 +126,2 @@ *Inherited from Error.message* | ||
___ | ||
<a id="name"></a> | ||
@@ -133,3 +131,3 @@ | ||
**● name**: *`string`* | ||
**● name**: *`string`* | ||
@@ -141,3 +139,2 @@ *Inherited from Error.name* | ||
___ | ||
<a id="stack"></a> | ||
@@ -147,3 +144,3 @@ | ||
**● stack**: *`string`* | ||
**● stack**: *`string`* | ||
@@ -166,3 +163,3 @@ *Inherited from Error.stack* | ||
*Defined in [error/coreError.ts:49](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L49)* | ||
*Defined in [error/coreError.ts:49](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L49)* | ||
@@ -175,3 +172,2 @@ Format the error to a readable version. | ||
___ | ||
<a id="iserror"></a> | ||
@@ -185,3 +181,3 @@ | ||
*Defined in [error/coreError.ts:41](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L41)* | ||
*Defined in [error/coreError.ts:41](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L41)* | ||
@@ -194,3 +190,3 @@ Check if an object could be a CoreError. | ||
| ------ | ------ | ------ | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
@@ -197,0 +193,0 @@ **Returns:** `boolean` |
@@ -37,3 +37,3 @@ [@iota-pico/core](../README.md) > [NullLogger](../classes/nulllogger.md) | ||
*Defined in [loggers/nullLogger.ts:12](https://github.com/iota-pico/core/blob/35412fd/src/loggers/nullLogger.ts#L12)* | ||
*Defined in [loggers/nullLogger.ts:12](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/nullLogger.ts#L12)* | ||
@@ -46,4 +46,4 @@ Send banner to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -53,3 +53,2 @@ **Returns:** `void` | ||
___ | ||
<a id="error"></a> | ||
@@ -63,3 +62,3 @@ | ||
*Defined in [loggers/nullLogger.ts:45](https://github.com/iota-pico/core/blob/35412fd/src/loggers/nullLogger.ts#L45)* | ||
*Defined in [loggers/nullLogger.ts:45](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/nullLogger.ts#L45)* | ||
@@ -72,5 +71,5 @@ Send error to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| err | `any` | An error object to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Optional` err | `any` | An error object to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -80,3 +79,2 @@ **Returns:** `void` | ||
___ | ||
<a id="info"></a> | ||
@@ -90,3 +88,3 @@ | ||
*Defined in [loggers/nullLogger.ts:28](https://github.com/iota-pico/core/blob/35412fd/src/loggers/nullLogger.ts#L28)* | ||
*Defined in [loggers/nullLogger.ts:28](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/nullLogger.ts#L28)* | ||
@@ -99,4 +97,4 @@ Send information to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -106,3 +104,2 @@ **Returns:** `void` | ||
___ | ||
<a id="log"></a> | ||
@@ -116,3 +113,3 @@ | ||
*Defined in [loggers/nullLogger.ts:20](https://github.com/iota-pico/core/blob/35412fd/src/loggers/nullLogger.ts#L20)* | ||
*Defined in [loggers/nullLogger.ts:20](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/nullLogger.ts#L20)* | ||
@@ -125,4 +122,4 @@ Send log to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -132,3 +129,2 @@ **Returns:** `void` | ||
___ | ||
<a id="warning"></a> | ||
@@ -142,3 +138,3 @@ | ||
*Defined in [loggers/nullLogger.ts:36](https://github.com/iota-pico/core/blob/35412fd/src/loggers/nullLogger.ts#L36)* | ||
*Defined in [loggers/nullLogger.ts:36](https://github.com/iota-pico/core/blob/0ebbbcc/src/loggers/nullLogger.ts#L36)* | ||
@@ -151,4 +147,4 @@ Send warning to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -155,0 +151,0 @@ **Returns:** `void` |
@@ -30,3 +30,3 @@ [@iota-pico/core](../README.md) > [NumberHelper](../classes/numberhelper.md) | ||
*Defined in [helpers/numberHelper.ts:28](https://github.com/iota-pico/core/blob/35412fd/src/helpers/numberHelper.ts#L28)* | ||
*Defined in [helpers/numberHelper.ts:28](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/numberHelper.ts#L28)* | ||
@@ -39,3 +39,3 @@ Is the value a float number formatted as a string, can be used for big numbers that would overflow parseFloat. | ||
| ------ | ------ | ------ | | ||
| value | `string` | The value to check | | ||
| value | `string` | The value to check | | ||
@@ -46,3 +46,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isinteger"></a> | ||
@@ -54,3 +53,3 @@ | ||
*Defined in [helpers/numberHelper.ts:10](https://github.com/iota-pico/core/blob/35412fd/src/helpers/numberHelper.ts#L10)* | ||
*Defined in [helpers/numberHelper.ts:10](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/numberHelper.ts#L10)* | ||
@@ -63,3 +62,3 @@ Is the value an integer. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test for its integerness. | | ||
| value | `any` | Object to test for its integerness. | | ||
@@ -70,3 +69,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isintegerstring"></a> | ||
@@ -78,3 +76,3 @@ | ||
*Defined in [helpers/numberHelper.ts:37](https://github.com/iota-pico/core/blob/35412fd/src/helpers/numberHelper.ts#L37)* | ||
*Defined in [helpers/numberHelper.ts:37](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/numberHelper.ts#L37)* | ||
@@ -87,3 +85,3 @@ Is the value a integer number formatted as a string, can be used for big numbers that would overflow parseInt. | ||
| ------ | ------ | ------ | | ||
| value | `string` | The value to check | | ||
| value | `string` | The value to check | | ||
@@ -94,3 +92,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isnumber"></a> | ||
@@ -102,3 +99,3 @@ | ||
*Defined in [helpers/numberHelper.ts:19](https://github.com/iota-pico/core/blob/35412fd/src/helpers/numberHelper.ts#L19)* | ||
*Defined in [helpers/numberHelper.ts:19](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/numberHelper.ts#L19)* | ||
@@ -111,3 +108,3 @@ Is the value a number. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test for its numberyness. | | ||
| value | `any` | Object to test for its numberyness. | | ||
@@ -114,0 +111,0 @@ **Returns:** `boolean` |
@@ -30,3 +30,3 @@ [@iota-pico/core](../README.md) > [ObjectHelper](../classes/objecthelper.md) | ||
*Defined in [helpers/objectHelper.ts:40](https://github.com/iota-pico/core/blob/35412fd/src/helpers/objectHelper.ts#L40)* | ||
*Defined in [helpers/objectHelper.ts:40](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/objectHelper.ts#L40)* | ||
@@ -39,3 +39,3 @@ Get the class name of an object if it has one. | ||
| ------ | ------ | ------ | | ||
| object | `any` | The object to get the class name for. | | ||
| object | `any` | The object to get the class name for. | | ||
@@ -46,3 +46,2 @@ **Returns:** `string` | ||
___ | ||
<a id="isempty"></a> | ||
@@ -54,3 +53,3 @@ | ||
*Defined in [helpers/objectHelper.ts:10](https://github.com/iota-pico/core/blob/35412fd/src/helpers/objectHelper.ts#L10)* | ||
*Defined in [helpers/objectHelper.ts:10](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/objectHelper.ts#L10)* | ||
@@ -63,3 +62,3 @@ Is the value empty. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test. | | ||
| value | `any` | Object to test. | | ||
@@ -70,3 +69,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isobject"></a> | ||
@@ -78,3 +76,3 @@ | ||
*Defined in [helpers/objectHelper.ts:19](https://github.com/iota-pico/core/blob/35412fd/src/helpers/objectHelper.ts#L19)* | ||
*Defined in [helpers/objectHelper.ts:19](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/objectHelper.ts#L19)* | ||
@@ -87,3 +85,3 @@ Is the value an object. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test. | | ||
| value | `any` | Object to test. | | ||
@@ -94,3 +92,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="istype"></a> | ||
@@ -102,3 +99,3 @@ | ||
*Defined in [helpers/objectHelper.ts:30](https://github.com/iota-pico/core/blob/35412fd/src/helpers/objectHelper.ts#L30)* | ||
*Defined in [helpers/objectHelper.ts:30](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/objectHelper.ts#L30)* | ||
@@ -111,4 +108,4 @@ Is the value an object if given type. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test. | | ||
| typeConstructor | `Function` | A callback method which returns an instance of the object. | | ||
| value | `any` | Object to test. | | ||
| typeConstructor | `Function` | A callback method which returns an instance of the object. | | ||
@@ -115,0 +112,0 @@ **Returns:** `boolean` |
@@ -9,3 +9,3 @@ [@iota-pico/core](../README.md) > [PlatformCryptoFactory](../classes/platformcryptofactory.md) | ||
[FactoryBase](factorybase.md)[IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
[FactoryBase](factorybase.md)<[IPlatformCrypto](../interfaces/iplatformcrypto.md)> | ||
@@ -38,3 +38,3 @@ **↳ PlatformCryptoFactory** | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L50)* | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L50)* | ||
@@ -47,4 +47,4 @@ Create an instance of an object from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to create. | | ||
| args | `any`[] | Any parameters to pass to the constructor. | | ||
| name | `string` | The name of the type to create. | | ||
| `Rest` args | `any`[] | Any parameters to pass to the constructor. | | ||
@@ -55,3 +55,2 @@ **Returns:** [IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
___ | ||
<a id="exists"></a> | ||
@@ -65,3 +64,3 @@ | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L31)* | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L31)* | ||
@@ -74,3 +73,3 @@ Does the factory contain a specific type. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to look for. | | ||
| name | `string` | The name of the type to look for. | | ||
@@ -81,3 +80,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="getinstance"></a> | ||
@@ -87,12 +85,11 @@ | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)[IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)<[IPlatformCrypto](../interfaces/iplatformcrypto.md)> | ||
*Overrides [FactoryBase](factorybase.md).[getInstance](factorybase.md#getinstance)* | ||
*Defined in [factories/platformCryptoFactory.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/platformCryptoFactory.ts#L31)* | ||
*Defined in [factories/platformCryptoFactory.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/platformCryptoFactory.ts#L31)* | ||
**Returns:** [FactoryBase](factorybase.md)[IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
**Returns:** [FactoryBase](factorybase.md)<[IPlatformCrypto](../interfaces/iplatformcrypto.md)> | ||
___ | ||
<a id="register"></a> | ||
@@ -106,3 +103,3 @@ | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L14)* | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L14)* | ||
@@ -115,4 +112,4 @@ Register a new type with the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
@@ -122,3 +119,2 @@ **Returns:** `void` | ||
___ | ||
<a id="types"></a> | ||
@@ -132,3 +128,3 @@ | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L40)* | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L40)* | ||
@@ -141,3 +137,2 @@ List the types in the factory. | ||
___ | ||
<a id="unregister"></a> | ||
@@ -151,3 +146,3 @@ | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L22)* | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L22)* | ||
@@ -160,3 +155,3 @@ Unregister a type from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to unregister. | | ||
| name | `string` | The name of the type to unregister. | | ||
@@ -166,3 +161,2 @@ **Returns:** `void` | ||
___ | ||
<a id="instance"></a> | ||
@@ -172,9 +166,9 @@ | ||
▸ **instance**(): [FactoryBase](factorybase.md)[IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
▸ **instance**(): [FactoryBase](factorybase.md)<[IPlatformCrypto](../interfaces/iplatformcrypto.md)> | ||
*Defined in [factories/platformCryptoFactory.ts:23](https://github.com/iota-pico/core/blob/35412fd/src/factories/platformCryptoFactory.ts#L23)* | ||
*Defined in [factories/platformCryptoFactory.ts:23](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/platformCryptoFactory.ts#L23)* | ||
Get the instance of the factory. | ||
**Returns:** [FactoryBase](factorybase.md)[IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
**Returns:** [FactoryBase](factorybase.md)<[IPlatformCrypto](../interfaces/iplatformcrypto.md)> | ||
The factory instance. | ||
@@ -181,0 +175,0 @@ |
@@ -39,7 +39,9 @@ [@iota-pico/core](../README.md) > [PlatformError](../classes/platformerror.md) | ||
### ⊕ **new PlatformError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [PlatformError](platformerror.md) | ||
### constructor | ||
⊕ **new PlatformError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [PlatformError](platformerror.md) | ||
*Overrides [CoreError](coreerror.md).[constructor](coreerror.md#constructor)* | ||
*Defined in [error/platformError.ts:6](https://github.com/iota-pico/core/blob/35412fd/src/error/platformError.ts#L6)* | ||
*Defined in [error/platformError.ts:6](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/platformError.ts#L6)* | ||
@@ -52,9 +54,9 @@ Create an instance of PlatformError. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message for the error. | | ||
| additional | `object` | Additional details about the error. | | ||
| innerError | `Error` | Add information from inner error if there was one. | | ||
| message | `string` | The message for the error. | | ||
| `Optional` additional | `object` | Additional details about the error. | | ||
| `Optional` innerError | `Error` | Add information from inner error if there was one. | | ||
**Returns:** [PlatformError](platformerror.md) | ||
--- | ||
___ | ||
@@ -67,7 +69,7 @@ ## Properties | ||
**● additional**: *`object`* | ||
**● additional**: *`object`* | ||
*Inherited from [CoreError](coreerror.md).[additional](coreerror.md#additional)* | ||
*Defined in [error/coreError.ts:16](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L16)* | ||
*Defined in [error/coreError.ts:16](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L16)* | ||
@@ -81,3 +83,2 @@ Additional details about the error. | ||
___ | ||
<a id="domain"></a> | ||
@@ -87,7 +88,7 @@ | ||
**● domain**: *`string`* | ||
**● domain**: *`string`* | ||
*Inherited from [CoreError](coreerror.md).[domain](coreerror.md#domain)* | ||
*Defined in [error/coreError.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L11)* | ||
*Defined in [error/coreError.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L11)* | ||
@@ -97,3 +98,2 @@ The domain of the error. | ||
___ | ||
<a id="innererror"></a> | ||
@@ -103,7 +103,7 @@ | ||
**● innerError**: *`Error`* | ||
**● innerError**: *`Error`* | ||
*Inherited from [CoreError](coreerror.md).[innerError](coreerror.md#innererror)* | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L21)* | ||
*Defined in [error/coreError.ts:21](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L21)* | ||
@@ -113,3 +113,2 @@ The inner error if there was one. | ||
___ | ||
<a id="message"></a> | ||
@@ -119,3 +118,3 @@ | ||
**● message**: *`string`* | ||
**● message**: *`string`* | ||
@@ -127,3 +126,2 @@ *Inherited from Error.message* | ||
___ | ||
<a id="name"></a> | ||
@@ -133,3 +131,3 @@ | ||
**● name**: *`string`* | ||
**● name**: *`string`* | ||
@@ -141,3 +139,2 @@ *Inherited from Error.name* | ||
___ | ||
<a id="stack"></a> | ||
@@ -147,3 +144,3 @@ | ||
**● stack**: *`string`* | ||
**● stack**: *`string`* | ||
@@ -166,3 +163,3 @@ *Inherited from Error.stack* | ||
*Defined in [error/coreError.ts:49](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L49)* | ||
*Defined in [error/coreError.ts:49](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L49)* | ||
@@ -175,3 +172,2 @@ Format the error to a readable version. | ||
___ | ||
<a id="iserror"></a> | ||
@@ -185,3 +181,3 @@ | ||
*Defined in [error/coreError.ts:41](https://github.com/iota-pico/core/blob/35412fd/src/error/coreError.ts#L41)* | ||
*Defined in [error/coreError.ts:41](https://github.com/iota-pico/core/blob/0ebbbcc/src/error/coreError.ts#L41)* | ||
@@ -194,3 +190,3 @@ Check if an object could be a CoreError. | ||
| ------ | ------ | ------ | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
@@ -197,0 +193,0 @@ **Returns:** `boolean` |
@@ -9,3 +9,3 @@ [@iota-pico/core](../README.md) > [RngServiceFactory](../classes/rngservicefactory.md) | ||
[FactoryBase](factorybase.md)[IRngService](../interfaces/irngservice.md) | ||
[FactoryBase](factorybase.md)<[IRngService](../interfaces/irngservice.md)> | ||
@@ -38,3 +38,3 @@ **↳ RngServiceFactory** | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L50)* | ||
*Defined in [factories/factoryBase.ts:50](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L50)* | ||
@@ -47,4 +47,4 @@ Create an instance of an object from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to create. | | ||
| args | `any`[] | Any parameters to pass to the constructor. | | ||
| name | `string` | The name of the type to create. | | ||
| `Rest` args | `any`[] | Any parameters to pass to the constructor. | | ||
@@ -55,3 +55,2 @@ **Returns:** [IRngService](../interfaces/irngservice.md) | ||
___ | ||
<a id="exists"></a> | ||
@@ -65,3 +64,3 @@ | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L31)* | ||
*Defined in [factories/factoryBase.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L31)* | ||
@@ -74,3 +73,3 @@ Does the factory contain a specific type. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to look for. | | ||
| name | `string` | The name of the type to look for. | | ||
@@ -81,3 +80,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="getinstance"></a> | ||
@@ -87,12 +85,11 @@ | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)[IRngService](../interfaces/irngservice.md) | ||
▸ **getInstance**(): [FactoryBase](factorybase.md)<[IRngService](../interfaces/irngservice.md)> | ||
*Overrides [FactoryBase](factorybase.md).[getInstance](factorybase.md#getinstance)* | ||
*Defined in [factories/rngServiceFactory.ts:31](https://github.com/iota-pico/core/blob/35412fd/src/factories/rngServiceFactory.ts#L31)* | ||
*Defined in [factories/rngServiceFactory.ts:31](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/rngServiceFactory.ts#L31)* | ||
**Returns:** [FactoryBase](factorybase.md)[IRngService](../interfaces/irngservice.md) | ||
**Returns:** [FactoryBase](factorybase.md)<[IRngService](../interfaces/irngservice.md)> | ||
___ | ||
<a id="register"></a> | ||
@@ -106,3 +103,3 @@ | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L14)* | ||
*Defined in [factories/factoryBase.ts:14](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L14)* | ||
@@ -115,4 +112,4 @@ Register a new type with the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
| name | `string` | The name of the type to register. | | ||
| typeConstructor | `function` | The constructor for the type. | | ||
@@ -122,3 +119,2 @@ **Returns:** `void` | ||
___ | ||
<a id="types"></a> | ||
@@ -132,3 +128,3 @@ | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L40)* | ||
*Defined in [factories/factoryBase.ts:40](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L40)* | ||
@@ -141,3 +137,2 @@ List the types in the factory. | ||
___ | ||
<a id="unregister"></a> | ||
@@ -151,3 +146,3 @@ | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/35412fd/src/factories/factoryBase.ts#L22)* | ||
*Defined in [factories/factoryBase.ts:22](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/factoryBase.ts#L22)* | ||
@@ -160,3 +155,3 @@ Unregister a type from the factory. | ||
| ------ | ------ | ------ | | ||
| name | `string` | The name of the type to unregister. | | ||
| name | `string` | The name of the type to unregister. | | ||
@@ -166,3 +161,2 @@ **Returns:** `void` | ||
___ | ||
<a id="instance"></a> | ||
@@ -172,9 +166,9 @@ | ||
▸ **instance**(): [FactoryBase](factorybase.md)[IRngService](../interfaces/irngservice.md) | ||
▸ **instance**(): [FactoryBase](factorybase.md)<[IRngService](../interfaces/irngservice.md)> | ||
*Defined in [factories/rngServiceFactory.ts:23](https://github.com/iota-pico/core/blob/35412fd/src/factories/rngServiceFactory.ts#L23)* | ||
*Defined in [factories/rngServiceFactory.ts:23](https://github.com/iota-pico/core/blob/0ebbbcc/src/factories/rngServiceFactory.ts#L23)* | ||
Get the instance of the factory. | ||
**Returns:** [FactoryBase](factorybase.md)[IRngService](../interfaces/irngservice.md) | ||
**Returns:** [FactoryBase](factorybase.md)<[IRngService](../interfaces/irngservice.md)> | ||
The factory instance. | ||
@@ -181,0 +175,0 @@ |
@@ -31,3 +31,3 @@ [@iota-pico/core](../README.md) > [StringHelper](../classes/stringhelper.md) | ||
*Defined in [helpers/stringHelper.ts:48](https://github.com/iota-pico/core/blob/35412fd/src/helpers/stringHelper.ts#L48)* | ||
*Defined in [helpers/stringHelper.ts:48](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/stringHelper.ts#L48)* | ||
@@ -40,3 +40,3 @@ Decode control characters to ASCII. | ||
| ------ | ------ | ------ | | ||
| value | `string` | The encoded string to convert back to ASCII. | | ||
| value | `string` | The encoded string to convert back to ASCII. | | ||
@@ -47,3 +47,2 @@ **Returns:** `string` | ||
___ | ||
<a id="encodenonascii"></a> | ||
@@ -55,3 +54,3 @@ | ||
*Defined in [helpers/stringHelper.ts:39](https://github.com/iota-pico/core/blob/35412fd/src/helpers/stringHelper.ts#L39)* | ||
*Defined in [helpers/stringHelper.ts:39](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/stringHelper.ts#L39)* | ||
@@ -64,3 +63,3 @@ Encode non ASCII characters with control characters. | ||
| ------ | ------ | ------ | | ||
| value | `string` | The string value to escape. | | ||
| value | `string` | The string value to escape. | | ||
@@ -71,3 +70,2 @@ **Returns:** `string` | ||
___ | ||
<a id="isascii"></a> | ||
@@ -79,3 +77,3 @@ | ||
*Defined in [helpers/stringHelper.ts:29](https://github.com/iota-pico/core/blob/35412fd/src/helpers/stringHelper.ts#L29)* | ||
*Defined in [helpers/stringHelper.ts:29](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/stringHelper.ts#L29)* | ||
@@ -88,3 +86,3 @@ Is the string all ASCII characters. | ||
| ------ | ------ | ------ | | ||
| value | `string` | string to test if is is ASCII. | | ||
| value | `string` | string to test if is is ASCII. | | ||
@@ -95,3 +93,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isempty"></a> | ||
@@ -103,3 +100,3 @@ | ||
*Defined in [helpers/stringHelper.ts:20](https://github.com/iota-pico/core/blob/35412fd/src/helpers/stringHelper.ts#L20)* | ||
*Defined in [helpers/stringHelper.ts:20](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/stringHelper.ts#L20)* | ||
@@ -112,3 +109,3 @@ Is the value a string that is empty. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test for its no emptyness. | | ||
| value | `any` | Object to test for its no emptyness. | | ||
@@ -119,3 +116,2 @@ **Returns:** `boolean` | ||
___ | ||
<a id="isstring"></a> | ||
@@ -127,3 +123,3 @@ | ||
*Defined in [helpers/stringHelper.ts:10](https://github.com/iota-pico/core/blob/35412fd/src/helpers/stringHelper.ts#L10)* | ||
*Defined in [helpers/stringHelper.ts:10](https://github.com/iota-pico/core/blob/0ebbbcc/src/helpers/stringHelper.ts#L10)* | ||
@@ -136,3 +132,3 @@ Is the value a string. | ||
| ------ | ------ | ------ | | ||
| value | `any` | Object to test for its stringyness. | | ||
| value | `any` | Object to test for its stringyness. | | ||
@@ -139,0 +135,0 @@ **Returns:** `boolean` |
@@ -33,3 +33,3 @@ [@iota-pico/core](../README.md) > [TimeService](../classes/timeservice.md) | ||
*Defined in [services/timeService.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/services/timeService.ts#L11)* | ||
*Defined in [services/timeService.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/services/timeService.ts#L11)* | ||
@@ -36,0 +36,0 @@ Returns the number of milliseconds since 1970/01/01. |
@@ -30,5 +30,5 @@ [@iota-pico/core](../README.md) > [IBackgroundTaskService](../interfaces/ibackgroundtaskservice.md) | ||
▸ **create**T(task: *`function`*, delay: *`number`*): `Promise`.<`T`> | ||
▸ **create**T(task: *`function`*, delay: *`number`*): `Promise`<`T`> | ||
*Defined in [interfaces/IBackgroundTaskService.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IBackgroundTaskService.ts#L11)* | ||
*Defined in [interfaces/IBackgroundTaskService.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IBackgroundTaskService.ts#L11)* | ||
@@ -44,8 +44,8 @@ Create a background task. | ||
| ------ | ------ | ------ | | ||
| task | `function` | The task to run in the background. | | ||
| delay | `number` | The delay before running the task. | | ||
| task | `function` | The task to run in the background. | | ||
| delay | `number` | The delay before running the task. | | ||
**Returns:** `Promise`.<`T`> | ||
**Returns:** `Promise`<`T`> | ||
___ | ||
@@ -37,3 +37,3 @@ [@iota-pico/core](../README.md) > [ILogger](../interfaces/ilogger.md) | ||
*Defined in [interfaces/ILogger.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/ILogger.ts#L11)* | ||
*Defined in [interfaces/ILogger.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/ILogger.ts#L11)* | ||
@@ -46,4 +46,4 @@ Send banner to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -53,3 +53,2 @@ **Returns:** `void` | ||
___ | ||
<a id="error"></a> | ||
@@ -61,3 +60,3 @@ | ||
*Defined in [interfaces/ILogger.ts:36](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/ILogger.ts#L36)* | ||
*Defined in [interfaces/ILogger.ts:36](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/ILogger.ts#L36)* | ||
@@ -70,5 +69,5 @@ Send error to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| err | `any` | An error object to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Optional` err | `any` | An error object to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -78,3 +77,2 @@ **Returns:** `void` | ||
___ | ||
<a id="info"></a> | ||
@@ -86,3 +84,3 @@ | ||
*Defined in [interfaces/ILogger.ts:23](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/ILogger.ts#L23)* | ||
*Defined in [interfaces/ILogger.ts:23](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/ILogger.ts#L23)* | ||
@@ -95,4 +93,4 @@ Send information to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -102,3 +100,2 @@ **Returns:** `void` | ||
___ | ||
<a id="log"></a> | ||
@@ -110,3 +107,3 @@ | ||
*Defined in [interfaces/ILogger.ts:17](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/ILogger.ts#L17)* | ||
*Defined in [interfaces/ILogger.ts:17](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/ILogger.ts#L17)* | ||
@@ -119,4 +116,4 @@ Send log to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -126,3 +123,2 @@ **Returns:** `void` | ||
___ | ||
<a id="warning"></a> | ||
@@ -134,3 +130,3 @@ | ||
*Defined in [interfaces/ILogger.ts:29](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/ILogger.ts#L29)* | ||
*Defined in [interfaces/ILogger.ts:29](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/ILogger.ts#L29)* | ||
@@ -143,4 +139,4 @@ Send warning to the logger. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message to log. | | ||
| args | `any`[] | Additional parameters to log. | | ||
| message | `string` | The message to log. | | ||
| `Rest` args | `any`[] | Additional parameters to log. | | ||
@@ -147,0 +143,0 @@ **Returns:** `void` |
@@ -30,5 +30,5 @@ [@iota-pico/core](../README.md) > [INetworkClient](../interfaces/inetworkclient.md) | ||
▸ **doRequest**(method: *`string`*, data: *`string`*, additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`.<`string`> | ||
▸ **doRequest**(method: *`string`*, data: *`string`*, additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`<`string`> | ||
*Defined in [interfaces/INetworkClient.ts:51](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkClient.ts#L51)* | ||
*Defined in [interfaces/INetworkClient.ts:51](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkClient.ts#L51)* | ||
@@ -41,12 +41,11 @@ Perform a request asynchronously. | ||
| ------ | ------ | ------ | | ||
| method | `string` | The method to send the data with. | | ||
| data | `string` | The data to send. | | ||
| additionalPath | `string` | An additional path append to the endpoint path. | | ||
| additionalHeaders | `object` | Extra headers to send with the request. | | ||
| method | `string` | The method to send the data with. | | ||
| data | `string` | The data to send. | | ||
| `Optional` additionalPath | `string` | An additional path append to the endpoint path. | | ||
| `Optional` additionalHeaders | `object` | Extra headers to send with the request. | | ||
**Returns:** `Promise`.<`string`> | ||
**Returns:** `Promise`<`string`> | ||
Promise which resolves to the object returned or rejects with error. | ||
___ | ||
<a id="get"></a> | ||
@@ -56,5 +55,5 @@ | ||
▸ **get**(additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`.<`string`> | ||
▸ **get**(additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`<`string`> | ||
*Defined in [interfaces/INetworkClient.ts:12](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkClient.ts#L12)* | ||
*Defined in [interfaces/INetworkClient.ts:12](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkClient.ts#L12)* | ||
@@ -67,10 +66,9 @@ Get data asynchronously. | ||
| ------ | ------ | ------ | | ||
| additionalPath | `string` | An additional path append to the endpoint path. | | ||
| additionalHeaders | `object` | Extra headers to send with the request. | | ||
| `Optional` additionalPath | `string` | An additional path append to the endpoint path. | | ||
| `Optional` additionalHeaders | `object` | Extra headers to send with the request. | | ||
**Returns:** `Promise`.<`string`> | ||
**Returns:** `Promise`<`string`> | ||
Promise which resolves to the object returned or rejects with error. | ||
___ | ||
<a id="getjson"></a> | ||
@@ -80,5 +78,5 @@ | ||
▸ **getJson**U(additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`.<`U`> | ||
▸ **getJson**U(additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`<`U`> | ||
*Defined in [interfaces/INetworkClient.ts:30](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkClient.ts#L30)* | ||
*Defined in [interfaces/INetworkClient.ts:30](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkClient.ts#L30)* | ||
@@ -97,10 +95,9 @@ Get data as JSON asynchronously. | ||
| ------ | ------ | ------ | | ||
| additionalPath | `string` | An additional path append to the endpoint path. | | ||
| additionalHeaders | `object` | Extra headers to send with the request. | | ||
| `Optional` additionalPath | `string` | An additional path append to the endpoint path. | | ||
| `Optional` additionalHeaders | `object` | Extra headers to send with the request. | | ||
**Returns:** `Promise`.<`U`> | ||
**Returns:** `Promise`<`U`> | ||
Promise which resolves to the object returned or rejects with error. | ||
___ | ||
<a id="post"></a> | ||
@@ -110,5 +107,5 @@ | ||
▸ **post**(data: *`string`*, additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`.<`string`> | ||
▸ **post**(data: *`string`*, additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`<`string`> | ||
*Defined in [interfaces/INetworkClient.ts:21](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkClient.ts#L21)* | ||
*Defined in [interfaces/INetworkClient.ts:21](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkClient.ts#L21)* | ||
@@ -121,11 +118,10 @@ Post data asynchronously. | ||
| ------ | ------ | ------ | | ||
| data | `string` | The data to send. | | ||
| additionalPath | `string` | An additional path append to the endpoint path. | | ||
| additionalHeaders | `object` | Extra headers to send with the request. | | ||
| data | `string` | The data to send. | | ||
| `Optional` additionalPath | `string` | An additional path append to the endpoint path. | | ||
| `Optional` additionalHeaders | `object` | Extra headers to send with the request. | | ||
**Returns:** `Promise`.<`string`> | ||
**Returns:** `Promise`<`string`> | ||
Promise which resolves to the object returned or rejects with error. | ||
___ | ||
<a id="postjson"></a> | ||
@@ -135,5 +131,5 @@ | ||
▸ **postJson**T,U(data: *`T`*, additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`.<`U`> | ||
▸ **postJson**T,U(data: *`T`*, additionalPath?: *`string`*, additionalHeaders?: *`object`*): `Promise`<`U`> | ||
*Defined in [interfaces/INetworkClient.ts:41](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkClient.ts#L41)* | ||
*Defined in [interfaces/INetworkClient.ts:41](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkClient.ts#L41)* | ||
@@ -156,7 +152,7 @@ Post data as JSON asynchronously. | ||
| ------ | ------ | ------ | | ||
| data | `T` | The data to send. | | ||
| additionalPath | `string` | An additional path append to the endpoint path. | | ||
| additionalHeaders | `object` | Extra headers to send with the request. | | ||
| data | `T` | The data to send. | | ||
| `Optional` additionalPath | `string` | An additional path append to the endpoint path. | | ||
| `Optional` additionalHeaders | `object` | Extra headers to send with the request. | | ||
**Returns:** `Promise`.<`U`> | ||
**Returns:** `Promise`<`U`> | ||
Promise which resolves to the object returned or rejects with error. | ||
@@ -163,0 +159,0 @@ |
@@ -36,3 +36,3 @@ [@iota-pico/core](../README.md) > [INetworkEndPoint](../interfaces/inetworkendpoint.md) | ||
*Defined in [interfaces/INetworkEndPoint.ts:17](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkEndPoint.ts#L17)* | ||
*Defined in [interfaces/INetworkEndPoint.ts:17](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkEndPoint.ts#L17)* | ||
@@ -45,3 +45,2 @@ The host name or ip of the endpoint. | ||
___ | ||
<a id="getport"></a> | ||
@@ -53,3 +52,3 @@ | ||
*Defined in [interfaces/INetworkEndPoint.ts:22](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkEndPoint.ts#L22)* | ||
*Defined in [interfaces/INetworkEndPoint.ts:22](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkEndPoint.ts#L22)* | ||
@@ -62,3 +61,2 @@ The port of the endpoint. | ||
___ | ||
<a id="getprotocol"></a> | ||
@@ -70,3 +68,3 @@ | ||
*Defined in [interfaces/INetworkEndPoint.ts:12](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkEndPoint.ts#L12)* | ||
*Defined in [interfaces/INetworkEndPoint.ts:12](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkEndPoint.ts#L12)* | ||
@@ -79,3 +77,2 @@ The protocol to access the endpoint with. | ||
___ | ||
<a id="getrootpath"></a> | ||
@@ -87,3 +84,3 @@ | ||
*Defined in [interfaces/INetworkEndPoint.ts:27](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkEndPoint.ts#L27)* | ||
*Defined in [interfaces/INetworkEndPoint.ts:27](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkEndPoint.ts#L27)* | ||
@@ -96,3 +93,2 @@ The path to the endpoint. | ||
___ | ||
<a id="geturi"></a> | ||
@@ -104,3 +100,3 @@ | ||
*Defined in [interfaces/INetworkEndPoint.ts:32](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/INetworkEndPoint.ts#L32)* | ||
*Defined in [interfaces/INetworkEndPoint.ts:32](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/INetworkEndPoint.ts#L32)* | ||
@@ -107,0 +103,0 @@ The complete uri. |
@@ -33,3 +33,3 @@ [@iota-pico/core](../README.md) > [IPlatformCrypto](../interfaces/iplatformcrypto.md) | ||
*Defined in [interfaces/IPlatformCrypto.ts:20](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IPlatformCrypto.ts#L20)* | ||
*Defined in [interfaces/IPlatformCrypto.ts:20](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IPlatformCrypto.ts#L20)* | ||
@@ -42,4 +42,4 @@ Decrypt the given data. | ||
| ------ | ------ | ------ | | ||
| publicKey | `string` | The key to use for decrypting data. | | ||
| data | `string` | The data to decrypt. | | ||
| publicKey | `string` | The key to use for decrypting data. | | ||
| data | `string` | The data to decrypt. | | ||
@@ -50,3 +50,2 @@ **Returns:** `string` | ||
___ | ||
<a id="encrypt"></a> | ||
@@ -58,3 +57,3 @@ | ||
*Defined in [interfaces/IPlatformCrypto.ts:12](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IPlatformCrypto.ts#L12)* | ||
*Defined in [interfaces/IPlatformCrypto.ts:12](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IPlatformCrypto.ts#L12)* | ||
@@ -67,4 +66,4 @@ Encrypt the given data. | ||
| ------ | ------ | ------ | | ||
| privateKey | `string` | The key to use for encrypting data. | | ||
| data | `string` | The data to encrypt. | | ||
| privateKey | `string` | The key to use for encrypting data. | | ||
| data | `string` | The data to encrypt. | | ||
@@ -75,3 +74,2 @@ **Returns:** `string` | ||
___ | ||
<a id="hash"></a> | ||
@@ -81,5 +79,5 @@ | ||
▸ **hash**(algo: *`string`*, data: *`any`*, dataType?: *"utf8"⎮"ascii"⎮"latin1"*, encoding?: *"latin1"⎮"hex"⎮"base64"*): `any` | ||
▸ **hash**(algo: *`string`*, data: *`any`*, dataType?: *"utf8" |"ascii" |"latin1"*, encoding?: *"latin1" |"hex" |"base64"*): `any` | ||
*Defined in [interfaces/IPlatformCrypto.ts:47](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IPlatformCrypto.ts#L47)* | ||
*Defined in [interfaces/IPlatformCrypto.ts:47](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IPlatformCrypto.ts#L47)* | ||
@@ -92,6 +90,12 @@ Hash the data. | ||
| ------ | ------ | ------ | | ||
| algo | `string` | The algorithm to use. | | ||
| data | `any` | The data to hash. | | ||
| dataType | "utf8"⎮"ascii"⎮"latin1" | The type of the input data utf8, ascii, latin1. | | ||
| encoding | "latin1"⎮"hex"⎮"base64" | The encoding to return the data latin1, hex, base64. | | ||
| algo | `string` | The algorithm to use. | | ||
| data | `any` | The data to hash. | | ||
| `Optional` dataType | "utf8" | | ||
"ascii" | | ||
"latin1" | ||
| The type of the input data utf8, ascii, latin1. | | ||
| `Optional` encoding | "latin1" | | ||
"hex" | | ||
"base64" | ||
| The encoding to return the data latin1, hex, base64. | | ||
@@ -102,3 +106,2 @@ **Returns:** `any` | ||
___ | ||
<a id="hmac"></a> | ||
@@ -108,5 +111,5 @@ | ||
▸ **hmac**(algo: *`string`*, key: *`any`*, data: *`any`*, dataType?: *"utf8"⎮"ascii"⎮"latin1"*, encoding?: *"latin1"⎮"hex"⎮"base64"*): `any` | ||
▸ **hmac**(algo: *`string`*, key: *`any`*, data: *`any`*, dataType?: *"utf8" |"ascii" |"latin1"*, encoding?: *"latin1" |"hex" |"base64"*): `any` | ||
*Defined in [interfaces/IPlatformCrypto.ts:61](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IPlatformCrypto.ts#L61)* | ||
*Defined in [interfaces/IPlatformCrypto.ts:61](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IPlatformCrypto.ts#L61)* | ||
@@ -119,7 +122,13 @@ HMAC the data. | ||
| ------ | ------ | ------ | | ||
| algo | `string` | The algorithm to use. | | ||
| key | `any` | The key to hash the data with. | | ||
| data | `any` | The data to hash. | | ||
| dataType | "utf8"⎮"ascii"⎮"latin1" | The type of the input data utf8, ascii, latin1. | | ||
| encoding | "latin1"⎮"hex"⎮"base64" | The encoding to return the data latin1, hex, base64. | | ||
| algo | `string` | The algorithm to use. | | ||
| key | `any` | The key to hash the data with. | | ||
| data | `any` | The data to hash. | | ||
| `Optional` dataType | "utf8" | | ||
"ascii" | | ||
"latin1" | ||
| The type of the input data utf8, ascii, latin1. | | ||
| `Optional` encoding | "latin1" | | ||
"hex" | | ||
"base64" | ||
| The encoding to return the data latin1, hex, base64. | | ||
@@ -130,3 +139,2 @@ **Returns:** `any` | ||
___ | ||
<a id="sign"></a> | ||
@@ -138,3 +146,3 @@ | ||
*Defined in [interfaces/IPlatformCrypto.ts:28](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IPlatformCrypto.ts#L28)* | ||
*Defined in [interfaces/IPlatformCrypto.ts:28](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IPlatformCrypto.ts#L28)* | ||
@@ -147,4 +155,4 @@ Sign the given data. | ||
| ------ | ------ | ------ | | ||
| privateKey | `string` | The key to use for signing data. | | ||
| data | `string` | The data to sign. | | ||
| privateKey | `string` | The key to use for signing data. | | ||
| data | `string` | The data to sign. | | ||
@@ -155,3 +163,2 @@ **Returns:** `string` | ||
___ | ||
<a id="verify"></a> | ||
@@ -163,3 +170,3 @@ | ||
*Defined in [interfaces/IPlatformCrypto.ts:37](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IPlatformCrypto.ts#L37)* | ||
*Defined in [interfaces/IPlatformCrypto.ts:37](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IPlatformCrypto.ts#L37)* | ||
@@ -172,5 +179,5 @@ Verify the given data with the signature. | ||
| ------ | ------ | ------ | | ||
| publicKey | `string` | The key to use for verifying data. | | ||
| data | `string` | The data to verify. | | ||
| signature | `string` | The signature to verify againt the data. | | ||
| publicKey | `string` | The key to use for verifying data. | | ||
| data | `string` | The data to verify. | | ||
| signature | `string` | The signature to verify againt the data. | | ||
@@ -177,0 +184,0 @@ **Returns:** `boolean` |
@@ -28,3 +28,3 @@ [@iota-pico/core](../README.md) > [IRngService](../interfaces/irngservice.md) | ||
*Defined in [interfaces/IRngService.ts:11](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/IRngService.ts#L11)* | ||
*Defined in [interfaces/IRngService.ts:11](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/IRngService.ts#L11)* | ||
@@ -37,3 +37,3 @@ Generate an array of random numbers. | ||
| ------ | ------ | ------ | | ||
| length | `number` | The number of numbers to generate. | | ||
| length | `number` | The number of numbers to generate. | | ||
@@ -40,0 +40,0 @@ **Returns:** `Uint8Array` |
@@ -32,3 +32,3 @@ [@iota-pico/core](../README.md) > [ITimeService](../interfaces/itimeservice.md) | ||
*Defined in [interfaces/ITimeService.ts:10](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/ITimeService.ts#L10)* | ||
*Defined in [interfaces/ITimeService.ts:10](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/ITimeService.ts#L10)* | ||
@@ -35,0 +35,0 @@ Returns the number of milliseconds since 1970/01/01. |
@@ -49,5 +49,7 @@ | ||
**Τ NetworkProtocol**: *"http"⎮"https"* | ||
**ΤNetworkProtocol**: *"http" | | ||
"https" | ||
* | ||
*Defined in [interfaces/networkProtocol.ts:4](https://github.com/iota-pico/core/blob/35412fd/src/interfaces/networkProtocol.ts#L4)* | ||
*Defined in [interfaces/networkProtocol.ts:4](https://github.com/iota-pico/core/blob/0ebbbcc/src/interfaces/networkProtocol.ts#L4)* | ||
@@ -54,0 +56,0 @@ Represents the protocols for communicating. |
{ | ||
"name": "@iota-pico/core", | ||
"version": "0.9.3", | ||
"version": "0.9.4", | ||
"description": "IOTA Pico Framework Core", | ||
@@ -54,3 +54,3 @@ "typings": "dist/index.d.ts", | ||
"@babel/runtime": "^7.0.0-beta.42", | ||
"@types/chai": "^4.1.1", | ||
"@types/chai": "^4.1.3", | ||
"@types/mocha": "^5.2.0", | ||
@@ -68,4 +68,4 @@ "babel-loader": "^8.0.0-beta.0", | ||
"rimraf": "^2.6.2", | ||
"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", | ||
@@ -75,8 +75,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" | ||
} | ||
} |
@@ -1,3 +0,3 @@ | ||
[](https://raw.githubusercontent.com/https://github.com/iota-pico/core/master/LICENSE) [](https://travis-ci.org/https://github.com/iota-pico/core) [](https://nodesecurity.io/orgs/https://github.com/iota-pico/projects/e20fc901-e307-497a-82d0-e53689af9b02) | ||
[](https://coveralls.io/github/https://github.com/iota-pico/core) | ||
[](https://raw.githubusercontent.com/iota-pico/core/master/LICENSE) [](https://travis-ci.org/iota-pico/core) [](https://nodesecurity.io/orgs/iota-pico/projects/e20fc901-e307-497a-82d0-e53689af9b02) | ||
[](https://coveralls.io/github/iota-pico/core) | ||
@@ -4,0 +4,0 @@ # IOTA Pico Framework Core |
404593