Class CliArgsHandlerBase

Basic CLI arguments handler that handles common options.

Implements

ICliArgsHandler

Index

Constructors

Methods

handleArgs populateYargs getScriptOutput getSourceObjectFromString isDevelopmentEnvironment

Constructors

constructor

new CliArgsHandlerBase(initialContext?: IActionContext): CliArgsHandlerBase
Parameters
- OptionalinitialContext: IActionContext
Returns CliArgsHandlerBase
- Defined in actor-init-query/lib/cli/CliArgsHandlerBase.ts:20

Methods

handleArgs

handleArgs(
args: Record<string, any>,
context: Record<string, any>,
): Promise<void>
Process the incoming arguments, and modify the context if needed.
Parameters
- args: Record<string, any>
  The parsed yargs arguments.
- context: Record<string, any>
  The mutable context.
Returns Promise<void>
Implementation of ICliArgsHandler.handleArgs
- Defined in actor-init-query/lib/cli/CliArgsHandlerBase.ts:159

populateYargs

populateYargs(argumentsBuilder: Argv<any>): Argv<any>
Add to the yargs arguments builder.
Parameters
- argumentsBuilder: Argv<any>
  A yargs argument builder object.
Returns Argv<any>
Implementation of ICliArgsHandler.populateYargs
- Defined in actor-init-query/lib/cli/CliArgsHandlerBase.ts:66

`Static`getScriptOutput

getScriptOutput(command: string, fallback: string): Promise<string>
Parameters
- command: string
- fallback: string
Returns Promise<string>
- Defined in actor-init-query/lib/cli/CliArgsHandlerBase.ts:24

`Static`getSourceObjectFromString

getSourceObjectFromString(sourceString: string): Record<string, any>
Converts an URL like 'hypermedia@http://user:passwd@example.com to an IDataSource
Parameters
- sourceString: string
  An url with possibly a type and authorization.
Returns Record<string, any>
An IDataSource which represents the sourceString.
- Defined in actor-init-query/lib/cli/CliArgsHandlerBase.ts:44

`Static`isDevelopmentEnvironment

isDevelopmentEnvironment(): boolean
Returns boolean
- Defined in actor-init-query/lib/cli/CliArgsHandlerBase.ts:35