Application

The Application class serves as the main entry point for the command-line application. It provides static methods and properties to create and manage commands, options, arguments, and help documentation.

Example

// Initialize the application
Application.init();

// Create a new command
const myCommand = Application.createCommand('myCommand');
myCommand.description('This is my custom command');

// Add an option to the command
const myOption = Application.createOption('-f, --flag', 'A custom flag');
myCommand.addOption(myOption);

// Add an argument to the command
const myArgument = Application.createArgument('<arg>', 'A custom argument');
myCommand.addArgument(myArgument);

// Add the command to the program
Application.program.addCommand(myCommand);

// Parse the command-line arguments
Application.program.parse(process.argv);

Constructors

new Application()

new Application(): Application

Returns

Application

Properties

Property	Modifier	Type	Description
Argument	static	Constructor<Argument>	Constructor for the Argument class.
Command	static	Constructor<Command>	Constructor for the Command class.
commandsDir	static	string	‐
createArgument	static	(arg: any, description?: string) => Argument	Creates a new Argument instance.
createCommand	static	(name?: string) => Command	Creates a new Command instance.
createHelp	static	() => Help	Creates a new Help instance.
createOption	static	(flags: string, description?: string) => Option	Creates a new Option instance.
globalOptions?	static	GlobalOptionsValues	‐
Help	static	Constructor<Help>	Constructor for the Help class.
in	static	Macroable<Input, InputMacros>	Input handler for the application.
initialized	static	boolean	Indicates whether the application has been initialized.
log	static	Logger	‐
name	static	string	‐
Option	static	Constructor<Option>	Constructor for the Option class.
out	static	Macroable<Output, OutputMacros>	Output handler for the application.
path	static	Path	‐
program	static	Command	The main command program.
startFn	static	StartFn	‐

Methods

error()

static error(error, exit?): typeof Application

Parameters

Parameter	Type
error	string | Error
exit?	true | ExitCode

Returns

typeof Application

---

exit()

static exit(exitCode): never

Parameters

Parameter	Type	Default value
exitCode	ExitCode	ExitCode.OK

Returns

never

---

init()

static init(): typeof Application

Initializes the application. This method should be called before using any other methods.

Returns

typeof Application

The Application class.

---

start()

static start<T>(args): Promise<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
args	any[]

Returns

Promise<T>

---

testRun()

static testRun(target, fn): boolean

Starts the application with the specified arguments. This method should be called after initializing the application. If an error occurs during execution, the error will be logged and the application will exit with an error code.

Parameters

Parameter	Type	Description
target	string | Paths	The target path or object.
fn	(paths) => void	The function to run.

Returns

boolean

Example

// With string param
Application.testRun('data', (paths) => {
   console.log(paths.data);
});
With object param
Application.testRun(Application.paths, (paths) => {
   console.log(paths.data);
});