@twin.org/cli-core 0.0.1-next.9 → 0.0.2-next.10

package/docs/reference/classes/CLIDisplay.md

@@ -4,13 +4,13 @@ Display utilities for the CLI.
 
 ## Constructors
 
-### new CLIDisplay()
+### Constructor
 
-> **new CLIDisplay**(): [`CLIDisplay`](CLIDisplay.md)
+> **new CLIDisplay**(): `CLIDisplay`
 
 #### Returns
 
-[`CLIDisplay`](CLIDisplay.md)
+`CLIDisplay`
 
 ## Properties
 
@@ -22,10 +22,12 @@ The default output method for writing standard messages.
 
 #### Parameters
 
-• **buffer**: `string` \| `Uint8Array`
+##### buffer
 
 The message to output.
 
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
 #### Returns
 
 `void`
@@ -40,10 +42,12 @@ The default output method for writing error messages.
 
 #### Parameters
 
-• **buffer**: `string` \| `Uint8Array`
+##### buffer
 
 The message to output.
 
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
 #### Returns
 
 `void`
@@ -70,15 +74,21 @@ Display the header for the CLI.
 
 #### Parameters
 
-• **title**: `string`
+##### title
+
+`string`
 
 The title of the CLI.
 
-• **version**: `string`
+##### version
+
+`string`
 
 The version of the CLI.
 
-• **icon**: `string`
+##### icon
+
+`string`
 
 The icon for the CLI.
 
@@ -96,11 +106,15 @@ Display an error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to display.
 
-• **lineBreaks**: `boolean` = `true`
+##### lineBreaks
+
+`boolean` = `true`
 
 Whether to add a line break after the error.
 
@@ -118,7 +132,9 @@ Display a section.
 
 #### Parameters
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label for the section.
 
@@ -136,15 +152,21 @@ Display a value with a label.
 
 #### Parameters
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label for the value.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to display.
 
-• **indentLevel**: `number` = `0`
+##### indentLevel
+
+`number` = `0`
 
 The level of indentation.
 
@@ -156,17 +178,21 @@ The level of indentation.
 
 ### task()
 
-> `static` **task**(`label`, `task`?): `void`
+> `static` **task**(`label`, `task?`): `void`
 
 Display a task with a label.
 
 #### Parameters
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label for the value.
 
-• **task?**: `string`
+##### task?
+
+`string`
 
 The task to display.
 
@@ -196,7 +222,9 @@ Display formatted and colorized JSON.
 
 #### Parameters
 
-• **obj**: `unknown`
+##### obj
+
+`unknown`
 
 The object to display.
 
@@ -206,6 +234,26 @@ The object to display.
 
 ***
 
+### warning()
+
+> `static` **warning**(`label`): `void`
+
+Display a warning.
+
+#### Parameters
+
+##### label
+
+`string`
+
+The label for the warning.
+
+#### Returns
+
+`void`
+
+***
+
 ### done()
 
 > `static` **done**(): `void`
@@ -226,15 +274,21 @@ Start the spinner.
 
 #### Parameters
 
-• **i18nMessage**: `string` = `"cli.progress.pleaseWait"`
+##### i18nMessage
+
+`string` = `"cli.progress.pleaseWait"`
 
 The message to display with the spinner.
 
-• **spinnerCharacters**: `string`[] = `...`
+##### spinnerCharacters
+
+`string`[] = `...`
 
 The characters to use in the spinner.
 
-• **interval**: `number` = `100`
+##### interval
+
+`number` = `100`
 
 The interval for the spinner.
 

package/docs/reference/classes/CLIOptions.md

@@ -4,13 +4,13 @@ Utilities for getting standard options.
 
 ## Constructors
 
-### new CLIOptions()
+### Constructor
 
-> **new CLIOptions**(): [`CLIOptions`](CLIOptions.md)
+> **new CLIOptions**(): `CLIOptions`
 
 #### Returns
 
-[`CLIOptions`](CLIOptions.md)
+`CLIOptions`
 
 ## Methods
 
@@ -22,31 +22,43 @@ Get the options for output.
 
 #### Parameters
 
-• **command**: `Command`
+##### command
+
+`Command`
 
 The command to add the options to.
 
-• **opts**
+##### opts
 
 The options of what to include.
 
-• **opts.noConsole**: `boolean`
+###### noConsole
+
+`boolean`
 
 Do not output to the console.
 
-• **opts.json**: `boolean`
+###### json
+
+`boolean`
 
 Output to a JSON file.
 
-• **opts.env**: `boolean`
+###### env
+
+`boolean`
 
 Output to an environment file.
 
-• **opts.mergeJson**: `boolean`
+###### mergeJson
+
+`boolean`
 
 Merge existing JSON file.
 
-• **opts.mergeEnv**: `boolean`
+###### mergeEnv
+
+`boolean`
 
 Merge existing environment file.
 

package/docs/reference/classes/CLIParam.md

@@ -4,13 +4,13 @@ Parameter utilities for the CLI.
 
 ## Constructors
 
-### new CLIParam()
+### Constructor
 
-> **new CLIParam**(): [`CLIParam`](CLIParam.md)
+> **new CLIParam**(): `CLIParam`
 
 #### Returns
 
-[`CLIParam`](CLIParam.md)
+`CLIParam`
 
 ## Methods
 
@@ -22,15 +22,21 @@ Check the option to see if it exists.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean`
 
 Allow the option to be read from an env var.
 
@@ -50,19 +56,25 @@ An error if the option is invalid.
 
 > `static` **stringValue**(`optionName`, `optionValue`, `allowEnvVar`): `string`
 
-Check the option to see if it exists.
+Check the option to see if the String exists.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -78,23 +90,79 @@ An error if the option is invalid.
 
 ***
 
+### arrayOneOf()
+
+> `static` **arrayOneOf**\<`T`\>(`optionName`, `optionValue`, `validValues`, `allowEnvVar`): `T`
+
+Check the option to see if the value exists in the specific array.
+
+#### Type Parameters
+
+##### T
+
+`T` = `string`
+
+#### Parameters
+
+##### optionName
+
+`string`
+
+The name of the option.
+
+##### optionValue
+
+The option value.
+
+`undefined` | `string`
+
+##### validValues
+
+`T`[]
+
+The valid values.
+
+##### allowEnvVar
+
+`boolean` = `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`T`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
 ### url()
 
 > `static` **url**(`optionName`, `optionValue`, `allowEnvVar`): `string`
 
-Check the option to see if it a url.
+Check the option to see if it is a url.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -112,29 +180,39 @@ An error if the option is invalid.
 
 ### number()
 
-> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `number`
+> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
 
 Check the option to see if it exists and is a number.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
-• **minValue**: `number` = `0`
+##### minValue
+
+`number` = `0`
 
 The minimum value.
 
-• **maxValue?**: `number`
+##### maxValue?
+
+`number`
 
 The maximum value.
 
@@ -152,29 +230,39 @@ An error if the option is invalid.
 
 ### integer()
 
-> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `number`
+> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
 
 Check the option to see if it exists and is an integer.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
-• **minValue**: `number` = `0`
+##### minValue
+
+`number` = `0`
 
 The minimum value.
 
-• **maxValue?**: `number`
+##### maxValue?
+
+`number`
 
 The maximum value.
 
@@ -192,29 +280,39 @@ An error if the option is invalid.
 
 ### bigint()
 
-> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue`?): `bigint`
+> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `bigint`
 
 Check the option to see if it exists and is a big number.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
-• **minValue**: `bigint` = `...`
+##### minValue
+
+`bigint` = `0n`
 
 The minimum value.
 
-• **maxValue?**: `bigint`
+##### maxValue?
+
+`bigint`
 
 The maximum value.
 
@@ -238,15 +336,21 @@ Check the option to see if it exists and is a boolean.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -270,15 +374,21 @@ Check the option to see if it exists and is hex.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -302,15 +412,21 @@ Check the option to see if it exists and is base64.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -334,15 +450,21 @@ Check the option to see if it exists and is hex or base64.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.
 
@@ -366,15 +488,21 @@ Check the option to see if it exists and is bech32.
 
 #### Parameters
 
-• **optionName**: `string`
+##### optionName
+
+`string`
 
 The name of the option.
 
-• **optionValue**: `undefined` \| `string`
+##### optionValue
 
 The option value.
 
-• **allowEnvVar**: `boolean` = `true`
+`undefined` | `string`
+
+##### allowEnvVar
+
+`boolean` = `true`
 
 Allow the option to be read from an env var.