Class EgoCommand

Api command.

Hierarchy

CommandBase
- EgoCommand

Implements

Command

Index

Properties

Methods

Properties

description

description: "Runs an Express.js based REST API from current directory." = "Runs an Express.js based REST API from current directory."

A description text.

syntax

syntax: string = "[options]"

Syntax description, which is shown on help screen.

Methods

execute

execute(ctx: CommandExecuteContext): Promise<void>

Overrides CommandBase.execute
- Defined in src/commands/api/index.ts:68
inheritdoc

Parameters
- ctx: CommandExecuteContext
Returns Promise<void>

Private setupAPIRoute

setupAPIRoute(ctx: CommandExecuteContext, route: express.Router, app: express.Express): Promise<() => any>

- Defined in src/commands/api/index.ts:298
Parameters
- ctx: CommandExecuteContext
- route: express.Router
- app: express.Express
Returns Promise<() => any>

showHelp

showHelp(): Promise<void>

Overrides CommandBase.showHelp
- Defined in src/commands/api/index.ts:221
inheritdoc

Returns Promise<void>

Generated using TypeDoc