@twin.org/node-core 0.0.3-next.4 → 0.0.3-next.40

package/docs/reference/interfaces/ICacheMetadata.md

@@ -4,7 +4,7 @@ Metadata for cached HTTPS extensions.
 
 ## Properties
 
-### downloadedAt
+### downloadedAt {#downloadedat}
 
 > **downloadedAt**: `number`
 
@@ -12,7 +12,7 @@ Timestamp when the file was downloaded.
 
 ***
 
-### url
+### url {#url}
 
 > **url**: `string`
 
@@ -20,7 +20,7 @@ Original URL of the cached file.
 
 ***
 
-### size
+### size {#size}
 
 > **size**: `number`
 

package/docs/reference/interfaces/ICliArgs.md

@@ -0,0 +1,35 @@
+# Interface: ICliArgs
+
+Command to execute in the CLI.
+
+## Properties
+
+### nodePath? {#nodepath}
+
+> `optional` **nodePath?**: `string`
+
+The path of the node executable.
+
+***
+
+### scriptPath? {#scriptpath}
+
+> `optional` **scriptPath?**: `string`
+
+The path of the script to execute.
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: `object`[]
+
+The command line options.
+
+#### key
+
+> **key**: `string`
+
+#### value
+
+> **value**: `string`

package/docs/reference/interfaces/ICliCommand.md

@@ -0,0 +1,23 @@
+# Interface: ICliCommand
+
+Command to execute in the CLI.
+
+## Properties
+
+### definition {#definition}
+
+> **definition**: [`ICliCommandDefinition`](ICliCommandDefinition.md)
+
+The command to execute.
+
+***
+
+### params {#params}
+
+> **params**: `object`
+
+The params to execute the command with.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)

package/docs/reference/interfaces/ICliCommandDefinition.md

@@ -0,0 +1,101 @@
+# Interface: ICliCommandDefinition
+
+Command to execute in the CLI.
+
+## Properties
+
+### command {#command}
+
+> **command**: `string`
+
+The command name.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+The command description.
+
+***
+
+### example {#example}
+
+> **example**: `string`
+
+The example.
+
+***
+
+### params {#params}
+
+> **params**: [`ICliCommandDefinitionParam`](ICliCommandDefinitionParam.md)[]
+
+The params available for the command.
+
+***
+
+### action {#action}
+
+> **action**: (`engineCore`, `envVars`, `params`) => `Promise`\<`unknown`\>
+
+The method to execute for the command.
+
+#### Parameters
+
+##### engineCore
+
+`IEngineCore`
+
+##### envVars
+
+[`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+
+##### params
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+***
+
+### requiresEngineStarted? {#requiresenginestarted}
+
+> `optional` **requiresEngineStarted?**: `boolean`
+
+Indicates whether the engine needs to be started before executing the command.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### requiresNodeIdentity? {#requiresnodeidentity}
+
+> `optional` **requiresNodeIdentity?**: `boolean`
+
+Indicates whether the engine needs the node identity to be set if configured to use.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### requiresTenantId? {#requirestenantid}
+
+> `optional` **requiresTenantId?**: `boolean`
+
+Indicates whether the engine needs the tenant id to be set if configured to use.
+
+#### Default
+
+```ts
+true
+```

package/docs/reference/interfaces/ICliCommandDefinitionParam.md

@@ -0,0 +1,65 @@
+# Interface: ICliCommandDefinitionParam
+
+Command param to execute in the CLI.
+
+## Properties
+
+### key {#key}
+
+> **key**: `string`
+
+The param key.
+
+***
+
+### type {#type}
+
+> **type**: `"string"` \| `"number"` \| `"boolean"`
+
+The param type.
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: `string`[]
+
+Possible options for the param.
+
+***
+
+### extendedType? {#extendedtype}
+
+> `optional` **extendedType?**: `string`
+
+The extended type e.g. hex etc.
+
+***
+
+### required? {#required}
+
+> `optional` **required?**: `boolean`
+
+Whether the param is required.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### defaultValue? {#defaultvalue}
+
+> `optional` **defaultValue?**: [`CliCommandParamType`](../type-aliases/CliCommandParamType.md)
+
+The default value of the param.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+The param description.