@twin.org/node-core 0.0.3-next.3 → 0.0.3-next.31

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.