Class default

Hierarchy

default
- default

Index

Constructors

Properties

args commandTree currentCommand cwd env info log name timestamp

Methods

addCommand addCommands command commands entrypoint exit parse printUsage printUsageMissingCommand printUsageNoCommand run startREPL

Constructors

constructor

new default(...args): default
Parameters
- Rest ...args: [options: Partial<{
  info: string;
  name: string;
  }>]
Returns default
Overrides CommandContext.constructor
- Defined in cmds/cmds.ts:9

Properties

args

args: string[] = []

Extra arguments passed from the command line.

commandTree

commandTree: CommandTree<default> = {}

All registered commands.

currentCommand

currentCommand: string = ''

Currently executing command.

cwd

cwd: string = ...

Current working directory at launch of process.

env

env: Record<string, string> = ...

Process environment at lauch of process.

info

info: string

Description of this command tree.

log

log: Core.Console

name

name: string

Name of this command tree.

timestamp

timestamp: string = ...

Start of command execution.

Methods

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
Inherited from CommandContext.addCommand
- Defined in cmds/cmds.browser.ts:57

addCommands

addCommands(name, info, subtree): this
Attach a command subtree and return this.
Parameters
- name: string
- info: string
- subtree: default
Returns this
Inherited from CommandContext.addCommands
- Defined in cmds/cmds.browser.ts:79

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
Inherited from CommandContext.command
- Defined in cmds/cmds.browser.ts:47

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
Inherited from CommandContext.commands
- Defined in cmds/cmds.browser.ts:73

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)
```
- Defined in cmds/cmds.ts:22

exit

exit(code?): void
End the process.
Parameters
- code: number = 0
Returns void
- Defined in cmds/cmds.ts:46

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[]]
Inherited from CommandContext.parse
- Defined in cmds/cmds.browser.ts:87

printUsage

printUsage(__namedParameters): Promise<void>
Parameters
- __namedParameters: default
Returns Promise<void>
Inherited from CommandContext.printUsage
- Defined in cmds/cmds.browser.ts:118

printUsageMissingCommand

printUsageMissingCommand(arg0): Promise<void>
Parameters
- arg0: default
Returns Promise<void>
Inherited from CommandContext.printUsageMissingCommand
- Defined in cmds/cmds.browser.ts:114

printUsageNoCommand

printUsageNoCommand(arg0): Promise<void>
Parameters
- arg0: this
Returns Promise<void>
Inherited from CommandContext.printUsageNoCommand
- Defined in cmds/cmds.browser.ts:109

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>
Inherited from CommandContext.run
- Defined in cmds/cmds.browser.ts:92

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.
- Defined in cmds/cmds.ts:41

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Rest ...args: [options: Partial<{ info: string; name: string; }>]

Returns default

Properties

args

commandTree

currentCommand

cwd

env

info

log

name

timestamp

Methods

addCommand

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

Parameters

name: string

info: string

subtree: default

Returns this

command

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

Type Parameters

C extends default

Parameters

name: string

info: string

subtree: C

Returns C

entrypoint

Parameters

url: string

argv: string[] = ...

Returns this

Example

exit

Parameters

code: number = 0

Returns void

parse

Parameters

args: string[]

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

printUsage

Parameters

__namedParameters: default

Returns Promise<void>

printUsageMissingCommand

Parameters

arg0: default

Returns Promise<void>

printUsageNoCommand

Parameters

`Rest` ...args: [options: Partial<{
info: string;
name: string;
}>]

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

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