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

package/docs/reference/classes/CLIParam.md

@@ -14,9 +14,9 @@ Parameter utilities for the CLI.
 
 ## Methods
 
-### env()
+### env() {#env}
 
-> `static` **env**(`optionName`, `optionValue`, `allowEnvVar`): `undefined` \| `string`
+> `static` **env**(`optionName`, `optionValue`, `allowEnvVar`): `string` \| `undefined`
 
 Check the option to see if it exists.
 
@@ -30,9 +30,9 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
 ##### allowEnvVar
 
@@ -42,7 +42,7 @@ Allow the option to be read from an env var.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The final option value.
 
@@ -52,9 +52,9 @@ An error if the option is invalid.
 
 ***
 
-### stringValue()
+### stringValue() {#stringvalue}
 
-> `static` **stringValue**(`optionName`, `optionValue`, `allowEnvVar`): `string`
+> `static` **stringValue**(`optionName`, `optionValue`, `allowEnvVar?`): `string`
 
 Check the option to see if the String exists.
 
@@ -68,11 +68,11 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
@@ -90,11 +90,17 @@ An error if the option is invalid.
 
 ***
 
-### url()
+### arrayOneOf() {#arrayoneof}
 
-> `static` **url**(`optionName`, `optionValue`, `allowEnvVar`): `string`
+> `static` **arrayOneOf**\<`T`\>(`optionName`, `optionValue`, `validValues`, `allowEnvVar?`): `T`
 
-Check the option to see if it is a url.
+Check the option to see if the value exists in the specific array.
+
+#### Type Parameters
+
+##### T
+
+`T` = `string`
 
 #### Parameters
 
@@ -106,11 +112,17 @@ The name of the option.
 
 ##### optionValue
 
+`string` \| `undefined`
+
 The option value.
 
-`undefined` | `string`
+##### validValues
 
-##### allowEnvVar
+`T`[]
+
+The valid values.
+
+##### allowEnvVar?
 
 `boolean` = `true`
 
@@ -118,7 +130,7 @@ Allow the option to be read from an env var.
 
 #### Returns
 
-`string`
+`T`
 
 The final option value.
 
@@ -128,11 +140,11 @@ An error if the option is invalid.
 
 ***
 
-### number()
+### url() {#url}
 
-> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
+> `static` **url**(`optionName`, `optionValue`, `allowEnvVar?`): `string`
 
-Check the option to see if it exists and is a number.
+Check the option to see if it is a url.
 
 #### Parameters
 
@@ -144,31 +156,19 @@ The name of the option.
 
 ##### optionValue
 
+`string` \| `undefined`
+
 The option value.
 
-`undefined` | `string`
-
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
 Allow the option to be read from an env var.
 
-##### minValue
-
-`number` = `0`
-
-The minimum value.
-
-##### maxValue?
-
-`number`
-
-The maximum value.
-
 #### Returns
 
-`number`
+`string`
 
 The final option value.
 
@@ -178,11 +178,11 @@ An error if the option is invalid.
 
 ***
 
-### integer()
+### number() {#number}
 
-> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
+> `static` **number**(`optionName`, `optionValue`, `allowEnvVar?`, `minValue?`, `maxValue?`): `number`
 
-Check the option to see if it exists and is an integer.
+Check the option to see if it exists and is a number.
 
 #### Parameters
 
@@ -194,17 +194,17 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
 Allow the option to be read from an env var.
 
-##### minValue
+##### minValue?
 
 `number` = `0`
 
@@ -228,11 +228,11 @@ An error if the option is invalid.
 
 ***
 
-### bigint()
+### integer() {#integer}
 
-> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `bigint`
+> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar?`, `minValue?`, `maxValue?`): `number`
 
-Check the option to see if it exists and is a big number.
+Check the option to see if it exists and is an integer.
 
 #### Parameters
 
@@ -244,31 +244,31 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
 Allow the option to be read from an env var.
 
-##### minValue
+##### minValue?
 
-`bigint` = `0n`
+`number` = `0`
 
 The minimum value.
 
 ##### maxValue?
 
-`bigint`
+`number`
 
 The maximum value.
 
 #### Returns
 
-`bigint`
+`number`
 
 The final option value.
 
@@ -278,11 +278,11 @@ An error if the option is invalid.
 
 ***
 
-### boolean()
+### bigint() {#bigint}
 
-> `static` **boolean**(`optionName`, `optionValue`, `allowEnvVar`): `boolean`
+> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar?`, `minValue?`, `maxValue?`): `bigint`
 
-Check the option to see if it exists and is a boolean.
+Check the option to see if it exists and is a big number.
 
 #### Parameters
 
@@ -294,19 +294,31 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
 Allow the option to be read from an env var.
 
+##### minValue?
+
+`bigint` = `0n`
+
+The minimum value.
+
+##### maxValue?
+
+`bigint`
+
+The maximum value.
+
 #### Returns
 
-`boolean`
+`bigint`
 
 The final option value.
 
@@ -316,11 +328,11 @@ An error if the option is invalid.
 
 ***
 
-### hex()
+### boolean() {#boolean}
 
-> `static` **hex**(`optionName`, `optionValue`, `allowEnvVar`): `Uint8Array`
+> `static` **boolean**(`optionName`, `optionValue`, `allowEnvVar?`): `boolean`
 
-Check the option to see if it exists and is hex.
+Check the option to see if it exists and is a boolean.
 
 #### Parameters
 
@@ -332,11 +344,11 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
@@ -344,7 +356,7 @@ Allow the option to be read from an env var.
 
 #### Returns
 
-`Uint8Array`
+`boolean`
 
 The final option value.
 
@@ -354,11 +366,11 @@ An error if the option is invalid.
 
 ***
 
-### base64()
+### hex() {#hex}
 
-> `static` **base64**(`optionName`, `optionValue`, `allowEnvVar`): `Uint8Array`
+> `static` **hex**(`optionName`, `optionValue`, `allowEnvVar?`): `Uint8Array`
 
-Check the option to see if it exists and is base64.
+Check the option to see if it exists and is hex.
 
 #### Parameters
 
@@ -370,11 +382,11 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
@@ -392,11 +404,11 @@ An error if the option is invalid.
 
 ***
 
-### hexBase64()
+### base64() {#base64}
 
-> `static` **hexBase64**(`optionName`, `optionValue`, `allowEnvVar`): `Uint8Array`
+> `static` **base64**(`optionName`, `optionValue`, `allowEnvVar?`): `Uint8Array`
 
-Check the option to see if it exists and is hex or base64.
+Check the option to see if it exists and is base64.
 
 #### Parameters
 
@@ -408,11 +420,11 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
@@ -430,11 +442,11 @@ An error if the option is invalid.
 
 ***
 
-### bech32()
+### hexBase64() {#hexbase64}
 
-> `static` **bech32**(`optionName`, `optionValue`, `allowEnvVar`): `string`
+> `static` **hexBase64**(`optionName`, `optionValue`, `allowEnvVar?`): `Uint8Array`
 
-Check the option to see if it exists and is bech32.
+Check the option to see if it exists and is hex or base64.
 
 #### Parameters
 
@@ -446,11 +458,11 @@ The name of the option.
 
 ##### optionValue
 
-The option value.
+`string` \| `undefined`
 
-`undefined` | `string`
+The option value.
 
-##### allowEnvVar
+##### allowEnvVar?
 
 `boolean` = `true`
 
@@ -458,7 +470,7 @@ Allow the option to be read from an env var.
 
 #### Returns
 
-`string`
+`Uint8Array`
 
 The final option value.
 

package/docs/reference/classes/CLIUtils.md

@@ -14,7 +14,7 @@ Utilities function for helping in the CLI.
 
 ## Methods
 
-### fileExists()
+### fileExists() {#fileexists}
 
 > `static` **fileExists**(`filename`): `Promise`\<`boolean`\>
 
@@ -36,7 +36,7 @@ True if the file exists.
 
 ***
 
-### fileExistsSync()
+### fileExistsSync() {#fileexistssync}
 
 > `static` **fileExistsSync**(`filename`): `boolean`
 
@@ -58,7 +58,7 @@ True if the file exists.
 
 ***
 
-### dirExists()
+### dirExists() {#direxists}
 
 > `static` **dirExists**(`dir`): `Promise`\<`boolean`\>
 
@@ -80,7 +80,7 @@ True if the dir exists.
 
 ***
 
-### dirExistsSync()
+### dirExistsSync() {#direxistssync}
 
 > `static` **dirExistsSync**(`dir`): `boolean`
 
@@ -102,9 +102,9 @@ True if the dir exists.
 
 ***
 
-### readJsonFile()
+### readJsonFile() {#readjsonfile}
 
-> `static` **readJsonFile**\<`T`\>(`filename`): `Promise`\<`undefined` \| `T`\>
+> `static` **readJsonFile**\<`T`\>(`filename`): `Promise`\<`T` \| `undefined`\>
 
 Read a JSON file and parse it.
 
@@ -124,15 +124,15 @@ The filename to read.
 
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The parsed JSON.
 
 ***
 
-### readJsonFileSync()
+### readJsonFileSync() {#readjsonfilesync}
 
-> `static` **readJsonFileSync**\<`T`\>(`filename`): `undefined` \| `T`
+> `static` **readJsonFileSync**\<`T`\>(`filename`): `T` \| `undefined`
 
 Read a JSON file and parse it, synchronously.
 
@@ -152,15 +152,15 @@ The filename to read.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The parsed JSON.
 
 ***
 
-### readLinesFile()
+### readLinesFile() {#readlinesfile}
 
-> `static` **readLinesFile**(`filename`): `Promise`\<`undefined` \| `string`[]\>
+> `static` **readLinesFile**(`filename`): `Promise`\<`string`[] \| `undefined`\>
 
 Read a file as lines.
 
@@ -174,15 +174,15 @@ The filename to read.
 
 #### Returns
 
-`Promise`\<`undefined` \| `string`[]\>
+`Promise`\<`string`[] \| `undefined`\>
 
 The lines.
 
 ***
 
-### readLinesFileSync()
+### readLinesFileSync() {#readlinesfilesync}
 
-> `static` **readLinesFileSync**(`filename`): `undefined` \| `string`[]
+> `static` **readLinesFileSync**(`filename`): `string`[] \| `undefined`
 
 Read a file as lines, synchronously.
 
@@ -196,13 +196,13 @@ The filename to read.
 
 #### Returns
 
-`undefined` \| `string`[]
+`string`[] \| `undefined`
 
 The lines.
 
 ***
 
-### findNpmRoot()
+### findNpmRoot() {#findnpmroot}
 
 > `static` **findNpmRoot**(`rootFolder`): `Promise`\<`string`\>
 
@@ -224,7 +224,7 @@ The root path.
 
 ***
 
-### runShellCmd()
+### runShellCmd() {#runshellcmd}
 
 > `static` **runShellCmd**(`command`, `args`, `cwd`): `Promise`\<`void`\>
 
@@ -258,7 +258,7 @@ Promise to wait for command execution to complete.
 
 ***
 
-### runShellApp()
+### runShellApp() {#runshellapp}
 
 > `static` **runShellApp**(`app`, `args`, `cwd`): `Promise`\<`void`\>
 
@@ -292,7 +292,7 @@ Promise to wait for command execution to complete.
 
 ***
 
-### writeJsonFile()
+### writeJsonFile() {#writejsonfile}
 
 > `static` **writeJsonFile**\<`T`\>(`jsonFilename`, `data`, `append`): `Promise`\<`void`\>
 
@@ -308,9 +308,9 @@ Write a JSON file.
 
 ##### jsonFilename
 
-The filename to write.
+`string` \| `undefined`
 
-`undefined` | `string`
+The filename to write.
 
 ##### data
 
@@ -330,7 +330,7 @@ Append to the file.
 
 ***
 
-### writeEnvFile()
+### writeEnvFile() {#writeenvfile}
 
 > `static` **writeEnvFile**(`envFilename`, `data`, `append`): `Promise`\<`void`\>
 
@@ -340,9 +340,9 @@ Write an env file.
 
 ##### envFilename
 
-The filename to write.
+`string` \| `undefined`
 
-`undefined` | `string`
+The filename to write.
 
 ##### data
 

package/docs/reference/interfaces/ICliOptions.md

@@ -4,7 +4,7 @@ Options for the CLI.
 
 ## Properties
 
-### title
+### title {#title}
 
 > **title**: `string`
 
@@ -12,7 +12,7 @@ The title of the CLI.
 
 ***
 
-### appName
+### appName {#appname}
 
 > **appName**: `string`
 
@@ -20,7 +20,7 @@ The name of the app used to execute it.
 
 ***
 
-### version
+### version {#version}
 
 > **version**: `string`
 
@@ -28,7 +28,7 @@ The version of the app.
 
 ***
 
-### icon
+### icon {#icon}
 
 > **icon**: `string`
 
@@ -36,32 +36,32 @@ The icon for the CLI as an emoji character.
 
 ***
 
-### supportsLang?
+### supportsLang? {#supportslang}
 
-> `optional` **supportsLang**: `boolean`
+> `optional` **supportsLang?**: `boolean`
 
 Supports different languages.
 
 ***
 
-### supportsEnvFiles?
+### supportsEnvFiles? {#supportsenvfiles}
 
-> `optional` **supportsEnvFiles**: `boolean`
+> `optional` **supportsEnvFiles?**: `boolean`
 
 Supports the loading of env files.
 
 ***
 
-### overrideOutputWidth?
+### overrideOutputWidth? {#overrideoutputwidth}
 
-> `optional` **overrideOutputWidth**: `number`
+> `optional` **overrideOutputWidth?**: `number`
 
 Override the default output width.
 
 ***
 
-### showDevToolWarning?
+### showDevToolWarning? {#showdevtoolwarning}
 
-> `optional` **showDevToolWarning**: `boolean`
+> `optional` **showDevToolWarning?**: `boolean`
 
 Show a warning that this is a dev tool and not for production use.

package/docs/reference/interfaces/ICliOutputOptionsConsole.md

@@ -4,7 +4,7 @@ Options for the CLI Output for console.
 
 ## Properties
 
-### console
+### console {#console}
 
 > **console**: `boolean`
 

package/docs/reference/interfaces/ICliOutputOptionsEnv.md

@@ -4,15 +4,15 @@ Options for the CLI Output for env.
 
 ## Properties
 
-### env?
+### env? {#env}
 
-> `optional` **env**: `string`
+> `optional` **env?**: `string`
 
 Output the data to an environment file.
 
 ***
 
-### mergeEnv
+### mergeEnv {#mergeenv}
 
 > **mergeEnv**: `boolean`