Skip to main content
Module

x/denomander/src/Kernel.ts>default

Deno command-line interfaces made easy
Latest
class default
Abstract
import { default } from "https://deno.land/x/denomander@0.9.3/src/Kernel.ts";

It is the core of the app. It is responsible for almost everything. The executeProgram() is the starting point of the app.

Constructors

new
default(app_details?: KernelAppDetails)

Constructor of AppDetails object

Index Signatures

[key: string]: any

Properties

protected
_args: CustomArgs

Arguments passed by the user during runtime

optional
_app_description: string

The description of the app

optional
_app_name: string

The name of the app

optional
_app_version: string

The version of the app

aliases: Array<AliasCommandBuilder>

Holds all the command aliases

app_description: string

Getter of the app description

app_name: string

Getter of the app name

app_version: string

Getter of the app version

appOptions: AppOptions
optional
args: Arguments

The arguments object instance

available_actions: Array<Command>

Holds all the available actions

BASE_COMMAND: Command

The base command is needed to hold the default options like --help, --version

commands: Array<Command>

Holds all the commands

Default errors if no errors passed by user

globalOptions: Array<OptionBuilder>

Holds all the global options

readonly
isClassic
isHelpConfigured: boolean

If the user has defined a custom help

isVersionConfigured: boolean

If the user has defined a custom version

on_commands: Array<OnCommand>

Holds all the available .on() commands

throw_errors: boolean

User have the option to throw the errors. by default it is not enabled

versionOption: Option

The version Option instance

Methods

protected
detectBaseCommandOptions(): Kernel
protected
detectDefaultOptions(): Kernel

Detects the default options and prints the corresponding message

protected
detectEmptyArgs(): Kernel

Detects if there are no args and prints the help screen

protected
execute(): Kernel

Executes default commands (--help, --version)

protected
printDefaultHelp(): void

Passes the details and commands to prints the help screen

protected
run(): Kernel

The starting point of the program

protected
setup(): Kernel

Do some necessary setup

protected
setupGlobalOptions(): Kernel