Class WebdaConsole

Hierarchy

WebdaConsole

Properties

app

logger

onSIGINT

terminal

webda

Properties

app: Application

debuggerStatus: DebuggerStatus = DebuggerStatus.Stopped

extensions: object

Type declaration

[key: string]: WebdaShellExtension

logger: Logger

onSIGINT: function = undefined

Type declaration

- (): never
- Returns never
  - Defined in packages/shell/src/console/webda.ts:42

serverProcess: ChildProcess

terminal: WebdaTerminal

tscCompiler: ChildProcess

webda: WebdaServer

Methods

bold(str: string): string

Parameters
- str: string
Returns string
- Defined in packages/shell/src/console/webda.ts:45

config(argv: yargs.Arguments): Promise<number>

If deployment in argument: display or export the configuration Otherwise launch the configuration UI

Parameters
- argv: yargs.Arguments
Returns Promise<number>
- Defined in packages/shell/src/console/webda.ts:331

debug(argv: yargs.Arguments): Promise<unknown>

Launch debug on application

Compiling application as it is modified Relaunching the serve command on any new modification

Parameters
- argv: yargs.Arguments
Returns Promise<unknown>
- Defined in packages/shell/src/console/webda.ts:189

deploy(argv: yargs.Arguments): Promise<number>

Deploy the new code

Parameters
- argv: yargs.Arguments
Returns Promise<number>
- Defined in packages/shell/src/console/webda.ts:372

executeShellExtension(ext: WebdaShellExtension, relPath: string, argv: any): Promise<any>

Parameters
- ext: WebdaShellExtension
  
  extension to execute
- relPath: string
  
  relative path of the extension
- argv: any
  
  arguments passed to the shell
Returns Promise<any>
- Defined in packages/shell/src/console/webda.ts:712

fakeTerm(): Promise<void>

Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:479

generateOpenAPI(argv: yargs.Arguments): Promise<void>

Generate the OpenAPI definition in a file

If filename can end with .yml or .json to select the format

Parameters
- argv: yargs.Arguments
Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:750

generateRandomString(length?: number): Promise<string>

Generate a random string based on crypto random

Parameters
- Default value length: number = 256
  
  of the string
Returns Promise<string>
- Defined in packages/shell/src/console/webda.ts:723

generateSessionSecret(): Promise<void>

Generate a new sessionSecret for the application

Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:737

getDebuggerStatus(): DebuggerStatus

Get debugger current status

Returns DebuggerStatus
- Defined in packages/shell/src/console/webda.ts:810

getVersion(): any

Get shell package version

Returns any
- Defined in packages/shell/src/console/webda.ts:321

handleCommand(args: any, versions: any, output?: WorkerOutput): Promise<number>

Main command switch

Parse arguments Init logger Create Webda Application Run the command or display help

Parameters
- args: any
- versions: any
- Default value output: WorkerOutput = undefined
Returns Promise<number>
- Defined in packages/shell/src/console/webda.ts:426

handleCommandInternal(args: any, versions: any, output?: WorkerOutput): Promise<number>

Parameters
- args: any
- versions: any
- Default value output: WorkerOutput = undefined
Returns Promise<number>
- Defined in packages/shell/src/console/webda.ts:506

help(commands?: string[]): void

Parameters
- Default value commands: string[] = []
Returns void
- Defined in packages/shell/src/console/webda.ts:49

init(argv: yargs.Arguments, generatorName?: string): Promise<void>

Generate a new Webda Application based on yeoman

Parameters
- argv: yargs.Arguments
- Default value generatorName: string = "webda"
Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:384

initLogger(argv: yargs.Arguments): Promise<void>

Init loggers

Parameters
- argv: yargs.Arguments
Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:410

loadExtensions(appPath: any): number

Parameters
- appPath: any
Returns number
- Defined in packages/shell/src/console/webda.ts:434

log(level: WorkerLogLevel, ...args: any[]): void

Parameters
- level: WorkerLogLevel
- Rest ...args: any[]
Returns void
- Defined in packages/shell/src/console/webda.ts:822

migrateConfig(argv: yargs.Arguments): Promise<number>

If deployment in argument: display or export the configuration Otherwise launch the configuration UI

Parameters
- argv: yargs.Arguments
Returns Promise<number>
- Defined in packages/shell/src/console/webda.ts:353

output(...args: any[]): void

Parameters
- Rest ...args: any[]
Returns void
- Defined in packages/shell/src/console/webda.ts:818

parser(args: any): yargs.Arguments

Parameters
- args: any
Returns yargs.Arguments
- Defined in packages/shell/src/console/webda.ts:74

serve(argv: any): Promise<unknown>

Parameters
- argv: any
Returns Promise<unknown>
- Defined in packages/shell/src/console/webda.ts:112

serviceConfig(argv: any): Promise<number>

Get a service configuration

Parameters
- argv: any
Returns Promise<number>
- Defined in packages/shell/src/console/webda.ts:135

setDebuggerStatus(status: DebuggerStatus): void

Parameters
- status: DebuggerStatus
Returns void
- Defined in packages/shell/src/console/webda.ts:814

stopDebugger(): Promise<void>

Stop the debugger and wait for its complete stop

Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:789

typescriptWatch(stream: Transform): Promise<void>

Launch tsc --watch and pass output to the stream

Parameters
- stream: Transform
  
  to get output from
Returns Promise<void>
- Defined in packages/shell/src/console/webda.ts:769

worker(argv: yargs.Arguments): Promise<void | -1>

Run a method of a service

Parameters
- argv: yargs.Arguments
Returns Promise<void | -1>
- Defined in packages/shell/src/console/webda.ts:152

Generated using TypeDoc