Class CliArgsHandlerQuery

CLI arguments handler that handles options for query execution.

Implements

ICliArgsHandler

Index

Constructors

Methods

handleArgs populateYargs

Constructors

constructor

new CliArgsHandlerQuery(
    defaultQueryInputFormat: undefined | string,
    queryString: undefined | string,
    context: undefined | string,
    allowNoSources: undefined | boolean,
): CliArgsHandlerQuery
Parameters
- defaultQueryInputFormat: undefined | string
- queryString: undefined | string
- context: undefined | string
- allowNoSources: undefined | boolean
Returns CliArgsHandlerQuery
- Defined in actor-init-query/lib/cli/CliArgsHandlerQuery.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/CliArgsHandlerQuery.ts:115

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/CliArgsHandlerQuery.ts:32