Decaf-ts' CLI module

Example

run module command     - $ npx decaf <module name> <module command> ...<module command options>
get module help        - $ npx decaf help <module name>;
list imported modules  - $ npx decaf list;
get cli help           - $ npx decaf help;

Members

# static constant CLI_FILE_NAME

The standard filename for CLI module files where each library must export a single CliModule function

The filename that identifies Decaf CLI modules

View Source constants.ts, line 2

# static constant VERSION

A constant that holds the version string of the package, which is replaced during build

Stores the current package version

View Source version.ts, line 3

# static constant VERSION

A constant that holds the version string of the package, which is replaced during build

Stores the current package version

View Source version.ts, line 10

Type Definitions

# CliModule() → {Command|Promise.<Command>}

Defines the signature for CLI module functions that each Decaf module must export under the CLI_FILE_NAME file The function should return a Command object or a Promise that resolves to a Command object

Function type for Decaf CLI modules

View Source types.ts, line 6

Returns:

A Command object or Promise that resolves to a Command object

Type: Command | Promise.<Command>

ts-template

Example

Members

# static constant CLI_FILE_NAME

# static constant VERSION

# static constant VERSION

Type Definitions

# CliModule() → {Command|Promise.<Command>}