Class default

args

commandTree

currentCommand

cwd

env

info

log

name

timestamp

addCommand

• addCommand<X>(parameters, step): this

• Define a command and return this.

  Type Parameters

  • X extends StepFn<default, unknown>

  Parameters

  • parameters: {
        args: string;
        info: string;
        name: string;
    }

    • args: string

    • info: string

    • name: string

  • step: X

  Returns this

addCommands

• addCommands(name, info, subtree): this

• Attach a command subtree and return this.

  Parameters

  • name: string

  • info: string

  • subtree: default

  Returns this

command

• command<X>(parameters, step): X

• Define a command and return it.

  Type Parameters

  • X extends StepFn<default, unknown>

  Parameters

  • parameters: {
        args: string;
        info: string;
        name: string;
    }

    • args: string

    • info: string

    • name: string

  • step: X

  Returns X

commands

• commands<C>(name, info, subtree): C

• Attach a command subtree and return it.

  Type Parameters

  • C extends default

  Parameters

  • name: string

  • info: string

  • subtree: C

  Returns C

entrypoint

• entrypoint(url, argv?): this

• If this command tree is the default export of the process entrypoint, run the commands as specified by the process command line.

  Parameters

  • url: string

  • argv: string[] = ...

  Returns this

  Example

  export default myCommands.main(import.meta.url)
  Copy

exit

• exit(code?): void

• End the process.

  Parameters

  • code: number = 0

  Returns void

parse

• parse(args): [default | Command<default>, ...string[]]

• Filter commands by each word from the list of arguments then pass the rest as arguments to the found command.

  Parameters

  • args: string[]

  Returns [default | Command<default>, ...string[]]

printUsage

• printUsage(__namedParameters): Promise<void>

• Parameters

  • __namedParameters: default

  Returns Promise<void>

printUsageMissingCommand

• printUsageMissingCommand(arg0): Promise<void>

• Parameters

  • arg0: default

  Returns Promise<void>

printUsageNoCommand

• printUsageNoCommand(arg0): Promise<void>

• Parameters

  • arg0: this

  Returns Promise<void>

run

• run<T>(argv, context?): Promise<T>

• Run a command from this command tree.

  Type Parameters

  • T

  Parameters

  • argv: string[]

  • context: any = ...

  Returns Promise<T>

startREPL

• startREPL(): Promise<void>

• Start an interactive REPL with this deployment as global context.

  Returns Promise<void>

  Throws

  if the node:repl and node:vm native modules are unavailable.