With this package, you will be able to create prompts to interact with the command line in a simple way.
You can customize your indicator with numerous options and create commands too easy.
With this class, you can create your own prompt.
| Param | Description | Default |
|---|---|---|
| PromptConstructorOptions | The constructor options for this prompt | PromptConstructorOptions (default value) |
Check the types part to see more information
Add commands to the prompt.
| Param | Description | Default | Type |
|---|---|---|---|
| commands | The list of commands to add | undefined | [] |
...CommandsOptions | Array<CommandsOptions> |
Usage:
const prompt = new Prompt(/*Options*/);
prompt.addCommands(
{
name: 'install',
aliases: ['i'],
description: 'Install a package'
}
);<prompt>.reply(args?):ReplyResponse
Reply to a prompt interation.
| Param | Description | Default | Type |
|---|---|---|---|
| args | The args of the prompt | process.argv |
string |
Usage:
const prompt = new Prompt(/*Options*/);
let interaction = prompt.reply();| Property | Description | Type | Default | Required |
|---|---|---|---|---|
| commands | The commands of this prompt | Array<CommandsOptions> | [] |
❌ |
| prefix | The prefix options for this prompt | PrefixOptions | PrefixOptions (default value) | ❌ |
| options | The options for this prompt | PromptOptions | {} |
❌ |
| Property | Description | Type | Default | Required |
|---|---|---|---|---|
| name | The name of the command | string | undefined |
✅ |
| aliases | The aliases of this command | Array<string> | [] |
❌ |
| description | The description of this command | string | null |
❌ |
| options | The options of this command | Array<CommandOptions> | [] |
❌ |
| action | The action of this command. Launched when the command is invoked | CommandFunction() | () => {} |
❌ |
| type | The type of the value | "string" | "boolean" | "number" | "any" | "any" |
❌ |
| required | If the value of the command is required | boolean | false |
❌ |
| Property | Description | Type | Default | Required |
|---|---|---|---|---|
| name | The name of this option | string | undefined |
✅ |
| aliases | The aliases of this option | Array<string> | [] |
❌ |
| description | The description of this option | string | null |
❌ |
| type | The type of this option | "string" | "number" | "boolean" | "any" | "any" |
❌ |
| action | The action of this option. Launched when the option is invoked | OptionFunction() | () => {} |
❌ |
| Param | Description | Type | Required |
|---|---|---|---|
| options | The data of this function | CommandFunctionProperties | ❌ |
| Property | Description | Type | Default |
|---|---|---|---|
| args | The arguments of this interaction | Array<undefined> | [string, string | number | boolean][] | Array\<undefined> |
| commandValue | The value of this interaction | string | number | boolean | undefined |
| Param | Description | Type | Required |
|---|---|---|---|
| options | The data of this function | OptionFunctionProperties | ❌ |
| Property | Description | Type | Default |
|---|---|---|---|
| value | The value of this option | string | boolean | number | undefined |
| commandValue | The value of the interaction | string | number | boolean | undefined |
| Property | Description | Type | Default | Required |
|---|---|---|---|---|
| large | The large prefix for complete option name | string | -- |
❌ |
| sort | The sort prefix for alias option | string | - |
❌ |
| Property | Description | Type | Default | Required |
|---|---|---|---|---|
| errorMessages | A object with all error messages | ErrorMessages | {} |
❌ |
| Property | Description | Type | Default | Required |
|---|---|---|---|---|
| COMMAND_DOESNT_EXIST | Invoked when a command doesn't exist | string | "The command does not exist!" |
❌ |
| MALFORMED_COMMAND | Invoked when a command have bad sintaxis | string | "The command sintaxis isn't correct!" |
❌ |
| WRONG_DATA_TYPE | Invoked when you provide a incorrect data type in a command or option | string | "The option "{name}" wants this type: {type}" |
❌ |
| REQUIRED_VALUE | Invoked when the value of the command or options is required and the value is undefined | string | "The command value is required!" |
❌ |
| Property | Description | Type |
|---|---|---|
| commandName | The name of the launched command | string |
| value | The value of the interaction | string | number | boolean |
| arguments | The arguments of this interaction | Array<undefined> | [string, string | number | boolean][] |