@twin.org/node-core 0.0.3-next.27 → 0.0.3-next.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/README.md +3 -1
  2. package/dist/es/commands/bootstrapLegacy.js +2 -1
  3. package/dist/es/commands/bootstrapLegacy.js.map +1 -1
  4. package/dist/es/commands/identityVerificationMethodCreate.js +1 -1
  5. package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -1
  6. package/dist/es/node.js +1 -1
  7. package/dist/es/node.js.map +1 -1
  8. package/docs/changelog.md +15 -1
  9. package/docs/examples.md +99 -1
  10. package/docs/reference/functions/start.md +2 -2
  11. package/docs/reference/interfaces/ICacheMetadata.md +3 -3
  12. package/docs/reference/interfaces/ICliArgs.md +6 -6
  13. package/docs/reference/interfaces/ICliCommand.md +2 -2
  14. package/docs/reference/interfaces/ICliCommandDefinition.md +11 -11
  15. package/docs/reference/interfaces/ICliCommandDefinitionParam.md +11 -11
  16. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +280 -280
  17. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +308 -308
  18. package/docs/reference/interfaces/IModuleProtocol.md +3 -3
  19. package/docs/reference/interfaces/INodeEngineState.md +4 -4
  20. package/docs/reference/interfaces/INodeEnvironmentVariables.md +318 -318
  21. package/docs/reference/interfaces/INodeOptions.md +36 -36
  22. package/docs/reference/interfaces/IProtocolHandlerResult.md +2 -2
  23. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +1 -1
  24. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +1 -1
  25. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +1 -1
  26. package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +1 -1
  27. package/docs/reference/variables/ModuleProtocol.md +5 -5
  28. package/package.json +1 -1
  29. package/docs/detailed-guide.md +0 -129
package/docs/reference/interfaces/ICliCommandDefinition.md CHANGED
@@ -4,7 +4,7 @@ Command to execute in the CLI.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### command
7
+ ### command {#command}
8
8
 
9
9
  > **command**: `string`
10
10
 
@@ -12,7 +12,7 @@ The command name.
12
12
 
13
13
  ***
14
14
 
15
- ### description
15
+ ### description {#description}
16
16
 
17
17
  > **description**: `string`
18
18
 
@@ -20,7 +20,7 @@ The command description.
20
20
 
21
21
  ***
22
22
 
23
- ### example
23
+ ### example {#example}
24
24
 
25
25
  > **example**: `string`
26
26
 
@@ -28,7 +28,7 @@ The example.
28
28
 
29
29
  ***
30
30
 
31
- ### params
31
+ ### params {#params}
32
32
 
33
33
  > **params**: [`ICliCommandDefinitionParam`](ICliCommandDefinitionParam.md)[]
34
34
 
@@ -36,7 +36,7 @@ The params available for the command.
36
36
 
37
37
  ***
38
38
 
39
- ### action()
39
+ ### action {#action}
40
40
 
41
41
  > **action**: (`engineCore`, `envVars`, `params`) => `Promise`\<`unknown`\>
42
42
 
@@ -60,9 +60,9 @@ The method to execute for the command.
60
60
 
61
61
  ***
62
62
 
63
- ### requiresEngineStarted?
63
+ ### requiresEngineStarted? {#requiresenginestarted}
64
64
 
65
- > `optional` **requiresEngineStarted**: `boolean`
65
+ > `optional` **requiresEngineStarted?**: `boolean`
66
66
 
67
67
  Indicates whether the engine needs to be started before executing the command.
68
68
 
@@ -74,9 +74,9 @@ true
74
74
 
75
75
  ***
76
76
 
77
- ### requiresNodeIdentity?
77
+ ### requiresNodeIdentity? {#requiresnodeidentity}
78
78
 
79
- > `optional` **requiresNodeIdentity**: `boolean`
79
+ > `optional` **requiresNodeIdentity?**: `boolean`
80
80
 
81
81
  Indicates whether the engine needs the node identity to be set if configured to use.
82
82
 
@@ -88,9 +88,9 @@ true
88
88
 
89
89
  ***
90
90
 
91
- ### requiresTenantId?
91
+ ### requiresTenantId? {#requirestenantid}
92
92
 
93
- > `optional` **requiresTenantId**: `boolean`
93
+ > `optional` **requiresTenantId?**: `boolean`
94
94
 
95
95
  Indicates whether the engine needs the tenant id to be set if configured to use.
96
96
 
package/docs/reference/interfaces/ICliCommandDefinitionParam.md CHANGED
@@ -4,7 +4,7 @@ Command param to execute in the CLI.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### key
7
+ ### key {#key}
8
8
 
9
9
  > **key**: `string`
10
10
 
@@ -12,7 +12,7 @@ The param key.
12
12
 
13
13
  ***
14
14
 
15
- ### type
15
+ ### type {#type}
16
16
 
17
17
  > **type**: `"string"` \| `"number"` \| `"boolean"`
18
18
 
@@ -20,25 +20,25 @@ The param type.
20
20
 
21
21
  ***
22
22
 
23
- ### options?
23
+ ### options? {#options}
24
24
 
25
- > `optional` **options**: `string`[]
25
+ > `optional` **options?**: `string`[]
26
26
 
27
27
  Possible options for the param.
28
28
 
29
29
  ***
30
30
 
31
- ### extendedType?
31
+ ### extendedType? {#extendedtype}
32
32
 
33
- > `optional` **extendedType**: `string`
33
+ > `optional` **extendedType?**: `string`
34
34
 
35
35
  The extended type e.g. hex etc.
36
36
 
37
37
  ***
38
38
 
39
- ### required?
39
+ ### required? {#required}
40
40
 
41
- > `optional` **required**: `boolean`
41
+ > `optional` **required?**: `boolean`
42
42
 
43
43
  Whether the param is required.
44
44
 
@@ -50,15 +50,15 @@ true
50
50
 
51
51
  ***
52
52
 
53
- ### defaultValue?
53
+ ### defaultValue? {#defaultvalue}
54
54
 
55
- > `optional` **defaultValue**: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)
55
+ > `optional` **defaultValue?**: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)
56
56
 
57
57
  The default value of the param.
58
58
 
59
59
  ***
60
60
 
61
- ### description
61
+ ### description {#description}
62
62
 
63
63
  > **description**: `string`
64
64